TypeScript typings for Calendar API v3
Manipulates events and other calendar data.
For detailed description please check documentation.
Installing
Install typings for Calendar API:
npm install @types/gapi.client.calendar@v3 --save-dev
Usage
You need to initialize Google API client in your code:
gapi.load('client', () => {
});
Then load api client wrapper:
gapi.client.load('calendar', 'v3', () => {
});
Don't forget to authenticate your client before sending any request to resources:
var client_id = '',
scope = [
'https://www.googleapis.com/auth/calendar',
'https://www.googleapis.com/auth/calendar.events',
'https://www.googleapis.com/auth/calendar.events.readonly',
'https://www.googleapis.com/auth/calendar.readonly',
'https://www.googleapis.com/auth/calendar.settings.readonly',
],
immediate = true;
gapi.auth.authorize(
{ client_id: client_id, scope: scope, immediate: immediate },
authResult => {
if (authResult && !authResult.error) {
} else {
}
});
After that you can use Calendar API resources:
await gapi.client.calendar.acl.delete({ calendarId: "calendarId", ruleId: "ruleId", });
await gapi.client.calendar.acl.get({ calendarId: "calendarId", ruleId: "ruleId", });
await gapi.client.calendar.acl.insert({ calendarId: "calendarId", });
await gapi.client.calendar.acl.list({ calendarId: "calendarId", });
await gapi.client.calendar.acl.patch({ calendarId: "calendarId", ruleId: "ruleId", });
await gapi.client.calendar.acl.update({ calendarId: "calendarId", ruleId: "ruleId", });
await gapi.client.calendar.acl.watch({ calendarId: "calendarId", });
await gapi.client.calendar.calendarList.delete({ calendarId: "calendarId", });
await gapi.client.calendar.calendarList.get({ calendarId: "calendarId", });
await gapi.client.calendar.calendarList.insert({ });
await gapi.client.calendar.calendarList.list({ });
await gapi.client.calendar.calendarList.patch({ calendarId: "calendarId", });
await gapi.client.calendar.calendarList.update({ calendarId: "calendarId", });
await gapi.client.calendar.calendarList.watch({ });
await gapi.client.calendar.calendars.clear({ calendarId: "calendarId", });
await gapi.client.calendar.calendars.delete({ calendarId: "calendarId", });
await gapi.client.calendar.calendars.get({ calendarId: "calendarId", });
await gapi.client.calendar.calendars.insert({ });
await gapi.client.calendar.calendars.patch({ calendarId: "calendarId", });
await gapi.client.calendar.calendars.update({ calendarId: "calendarId", });
await gapi.client.calendar.channels.stop({ });
await gapi.client.calendar.colors.get({ });
await gapi.client.calendar.events.delete({ calendarId: "calendarId", eventId: "eventId", });
await gapi.client.calendar.events.get({ calendarId: "calendarId", eventId: "eventId", });
await gapi.client.calendar.events.import({ calendarId: "calendarId", });
await gapi.client.calendar.events.insert({ calendarId: "calendarId", });
await gapi.client.calendar.events.instances({ calendarId: "calendarId", eventId: "eventId", });
await gapi.client.calendar.events.list({ calendarId: "calendarId", });
await gapi.client.calendar.events.move({ calendarId: "calendarId", destination: "destination", eventId: "eventId", });
await gapi.client.calendar.events.patch({ calendarId: "calendarId", eventId: "eventId", });
await gapi.client.calendar.events.quickAdd({ calendarId: "calendarId", text: "text", });
await gapi.client.calendar.events.update({ calendarId: "calendarId", eventId: "eventId", });
await gapi.client.calendar.events.watch({ calendarId: "calendarId", });
await gapi.client.calendar.freebusy.query({ });
await gapi.client.calendar.settings.get({ setting: "setting", });
await gapi.client.calendar.settings.list({ });
await gapi.client.calendar.settings.watch({ });