gcal.onnewandupdatedeventsprops
Home > @runlightyear/gcal > OnNewAndUpdatedEventsProps
OnNewAndUpdatedEventsProps interface
Signature:interface OnNewAndUpdatedEventsProps
Required Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| name | string | ||
| run | OnNewAndUpdatedEventsRunFunc | ||
| title | string |
Optional Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| apps? | Array<AppName> | ||
| authName? | string | ||
| calendarId? | "primary" | string | Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. Default is "primary" | |
| customAppName? | string | ||
| customApps? | Array<string> | ||
| eventTypes? | Array<EventType> | Event types to return. Optional. The default is ["default", "outOfOffice", "focusTime"]. Only the default value is available, unless you're enrolled in the Working Locations developer preview. Developer Preview?: Available as part of the Google Workspace Developer Preview Program, which grants early access to certain features. | |
| iCalUID? | string | Specifies an event ID in the iCalendar format to be provided in the response. Optional. Use this if you want to search for an event by its iCalendar ID. | |
| maxAttendees? | number | The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional. | |
| maxResults? | number | Maximum number of events returned on one result page. The number of events in the resulting page may be less than this value, or none at all, even if there are more events matching the query. Incomplete pages can be detected by a non-empty nextPageToken field in the response. By default the value is 250 events. The page size can never be larger than 2500 events. | |
| pageToken? | string | Token specifying which result page to return. Optional. | |
| privateExtendedProperty? | string | Extended properties constraint specified as propertyName=value. Matches only private properties. This parameter might be repeated multiple times to return events that match all given constraints. | |
| q? | string | Free text search terms to find events that match these terms in the following fields?: summary, description, location, attendee's displayName, attendee's email. Optional. | |
| secrets? | Array<SecretDef> | ||
| sharedExtendedProperty? | string | Extended properties constraint specified as propertyName=value. Matches only shared properties. This parameter might be repeated multiple times to return events that match all given constraints. | |
| showHiddenInvitations? | boolean | Whether to include hidden invitations in the result. Optional. The default is False. | |
| singleEvents? | boolean | Whether to expand recurring events into instances and only return single one-off events and instances of recurring events, but not the underlying recurring events themselves. Optional. The default is False. | |
| timeMax? | DateTime | Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10?:00?:00-07?:00, 2011-06-03T10?:00?:00Z. Milliseconds may be provided but are ignored. If timeMin is set, timeMax must be greater than timeMin. | |
| timeMin? | DateTime | Lower bound (exclusive) for an event's end time to filter by. Optional. The default is not to filter by end time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10?:00?:00-07?:00, 2011-06-03T10?:00?:00Z. Milliseconds may be provided but are ignored. If timeMax is set, timeMin must be smaller than timeMax. | |
| timeZone? | string | Time zone used in the response. Optional. The default is the time zone of the calendar. | |
| variables? | Array<VariableDef> |