GoogleApi.Calendar.V3.Api.Events.calendar_events_patch

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

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

View Source

Specs

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

Updates an event. This method supports patch semantics.

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) - 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).

    • :conferenceDataVersion (type: integer()) - Version number of conference data supported by the API client. Version 0 assumes no conference data support and ignores conference data in the event's body. Version 1 enables support for copying of ConferenceData as well as for creating new conferences using the createRequest field of conferenceData. The default is 0.

    • :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.

    • :sendNotifications (type: boolean()) - Deprecated. Please use sendUpdates instead.

      Whether to send notifications about the event update (for example, description changes, etc.). Note that some emails might still be sent even if you set the value to false. The default is false.

    • :sendUpdates (type: String.t) - Guests who should receive notifications about the event update (for example, title changes, etc.).

    • :supportsAttachments (type: boolean()) - Whether API client performing operation supports event attachments. Optional. The default is False.

    • :body (type: GoogleApi.Calendar.V3.Model.Event.t) -

  • opts (type: keyword()) - Call options

Returns

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