GoogleApi.Calendar.V3.Api.Events.calendar_events_instances

You're seeing just the function calendar_events_instances, go back to GoogleApi.Calendar.V3.Api.Events module for more information.
Link to this function

calendar_events_instances(connection, calendar_id, event_id, optional_params \\ [], opts \\ [])

View Source

Specs

calendar_events_instances(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Calendar.V3.Model.Events.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Returns instances of the specified recurring event.

Parameters

  • connection (type: GoogleApi.Calendar.V3.Connection.t) - Connection to server
  • calendar_id (type: String.t) - 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.
  • event_id (type: String.t) - Recurring event identifier.
  • optional_params (type: keyword()) - Optional parameters
    • :alt (type: String.t) - Data format for the response.
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
    • :alwaysIncludeEmail (type: boolean()) - Deprecated and ignored. A value will always be returned in the email field for the organizer, creator and attendees, even if no real email address is available (i.e. a generated, non-working value will be provided).
    • :maxAttendees (type: integer()) - 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 (type: integer()) - 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.
    • :originalStart (type: String.t) - The original start time of the instance in the result. Optional.
    • :pageToken (type: String.t) - Token specifying which result page to return. Optional.
    • :showDeleted (type: boolean()) - Whether to include deleted events (with status equals "cancelled") in the result. Cancelled instances of recurring events will still be included if singleEvents is False. Optional. The default is False.
    • :timeMax (type: DateTime.t) - 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.
    • :timeMin (type: DateTime.t) - 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.
    • :timeZone (type: String.t) - Time zone used in the response. Optional. The default is the time zone of the calendar.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Calendar.V3.Model.Events{}} on success
  • {:error, info} on failure