-
Notifications
You must be signed in to change notification settings - Fork 10
Get GCalendarEvent
Returns an event.
Get-GCalendarEvent [-CalendarId] <String> [-EventId] <String> [[-AlwaysIncludeEmail] <Boolean>]
[[-MaxAttendees] <Int32>] [[-TimeZone] <String>] [-StandardQueryParams <StandardQueryParameters>]
[-GAuthId <String>] [-WhatIf] [-Confirm]
Get-GCalendarEvent [-CalendarId] <String> [[-AlwaysIncludeEmail] <Boolean>] [[-MaxAttendees] <Int32>]
[[-TimeZone] <String>] [[-ICalUID] <String>] [[-MaxResults] <Int32>] [[-OrderBy] <OrderByEnum>]
[[-PrivateExtendedProperty] <String[]>] [[-Q] <String>] [[-SharedExtendedProperty] <String[]>]
[[-ShowDeleted] <Boolean>] [[-ShowHiddenInvitations] <Boolean>] [[-SingleEvents] <Boolean>]
[[-SyncToken] <String>] [[-TimeMax] <DateTime>] [[-TimeMin] <DateTime>] [[-UpdatedMin] <DateTime>]
[-All] [-StandardQueryParams <StandardQueryParameters>] [-GAuthId <String>] [-WhatIf] [-Confirm]
Returns an event.
PS C:\> Get-GCalendarEvent -CalendarId $SomeCalendarIdString -EventId $SomeEventIdString
This automatically generated example serves to show the bare minimum required to call this Cmdlet.
Additional examples may be added, viewed and edited by users on the community wiki at the URL found in the related links.
PS C:\> Get-GCalendarEvent -CalendarId $SomeCalendarIdString -All
This automatically generated example serves to show the bare minimum required to call this Cmdlet.
Additional examples may be added, viewed and edited by users on the community wiki at the URL found in the related links.
A switch to list all results
Type: SwitchParameter
Parameter Sets: AllUserAliases
Aliases:
Required: False
Position: 17
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalseCalendar 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.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value:
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseEvent identifier.
Type: String
Parameter Sets: one
Aliases:
Required: True
Position: 1
Default value:
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseWhether to always include a value in the email field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value:
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseThe 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.
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value:
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseTime zone used in the response. Optional. The default is the time zone of the calendar.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 15
Default value:
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseSpecifies event ID in the iCalendar format to be included in the response. Optional.
Type: String
Parameter Sets: list
Aliases:
Required: False
Position: 2
Default value:
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseMaximum number of events returned on one result page. By default the value is 250 events. The page size can never be larger than 2500 events. Optional.
Type: Int32
Parameter Sets: list
Aliases:
Required: False
Position: 4
Default value:
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseThe order of the events returned in the result. Optional. The default is an unspecified, stable order.
Possible values: StartTime, Updated
Type: OrderByEnum
Parameter Sets: list
Aliases:
Accepted values: StartTime, Updated
Required: False
Position: 5
Default value:
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseExtended 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.
Type: String[]
Parameter Sets: list
Aliases:
Required: False
Position: 6
Default value:
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseFree text search terms to find events that match these terms in any field, except for extended properties. Optional.
Type: String
Parameter Sets: list
Aliases:
Required: False
Position: 7
Default value:
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseExtended 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.
Type: String[]
Parameter Sets: list
Aliases:
Required: False
Position: 8
Default value:
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseWhether to include deleted events (with status equals "cancelled") in the result. Cancelled instances of recurring events (but not the underlying recurring event) will still be included if showDeleted and singleEvents are both False. If showDeleted and singleEvents are both True, only single instances of deleted events (but not the underlying recurring events) are returned. Optional. The default is False.
Type: Boolean
Parameter Sets: list
Aliases:
Required: False
Position: 9
Default value:
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseWhether to include hidden invitations in the result. Optional. The default is False.
Type: Boolean
Parameter Sets: list
Aliases:
Required: False
Position: 10
Default value:
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseWhether 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.
Type: Boolean
Parameter Sets: list
Aliases:
Required: False
Position: 11
Default value:
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseToken obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All events deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False.There are several query parameters that cannot be specified together with nextSyncToken to ensure consistency of the client state.These are:- iCalUID- orderBy- privateExtendedProperty- q- sharedExtendedProperty- timeMin- timeMax- updatedMin If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken.Learn more about incremental synchronization.Optional. The default is to return all entries.
Type: String
Parameter Sets: list
Aliases:
Required: False
Position: 12
Default value:
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseUpper 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, e.g., 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but will be ignored.
Type: DateTime
Parameter Sets: list
Aliases:
Required: False
Position: 13
Default value:
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseLower bound (inclusive) 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, e.g., 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but will be ignored.
Type: DateTime
Parameter Sets: list
Aliases:
Required: False
Position: 14
Default value:
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseLower bound for an event's last modification time (as a RFC3339 timestamp) to filter by. When specified, entries deleted since this time will always be included regardless of showDeleted. Optional. The default is not to filter by last modification time.
Type: DateTime
Parameter Sets: list
Aliases:
Required: False
Position: 16
Default value:
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseA Standard Query Parameters Object.
Type: StandardQueryParameters
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value:
Accept pipeline input: False
Accept wildcard characters: FalseThe GAuthId representing the gShell auth credentials this cmdlet should use to run.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value:
Accept pipeline input: False
Accept wildcard characters: FalseCalendar 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.
Event identifier.
Whether to always include a value in the email field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False.
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.
Time zone used in the response. Optional. The default is the time zone of the calendar.
Specifies event ID in the iCalendar format to be included in the response. Optional.
Maximum number of events returned on one result page. By default the value is 250 events. The page size can never be larger than 2500 events. Optional.
The order of the events returned in the result. Optional. The default is an unspecified, stable order.
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.
Free text search terms to find events that match these terms in any field, except for extended properties. Optional.
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.
Whether to include deleted events (with status equals "cancelled") in the result. Cancelled instances of recurring events (but not the underlying recurring event) will still be included if showDeleted and singleEvents are both False. If showDeleted and singleEvents are both True, only single instances of deleted events (but not the underlying recurring events) are returned. Optional. The default is False.
Whether to include hidden invitations in the result. Optional. The default is False.
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.
Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All events deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False.There are several query parameters that cannot be specified together with nextSyncToken to ensure consistency of the client state.These are:- iCalUID- orderBy- privateExtendedProperty- q- sharedExtendedProperty- timeMin- timeMax- updatedMin If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken.Learn more about incremental synchronization.Optional. The default is to return all entries.
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, e.g., 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but will be ignored.
Lower bound (inclusive) 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, e.g., 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but will be ignored.
Lower bound for an event's last modification time (as a RFC3339 timestamp) to filter by. When specified, entries deleted since this time will always be included regardless of showDeleted. Optional. The default is not to filter by last modification time.
Part of the gShell Project, relating to the Google Calendar API; see Related Links or use the -Online parameter.
News - Get Started - Cmdlet Index - FAQ - Discussion - Downloads