GoogleApi.Calendar.V3.Api.Events.calendar_events_delete

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

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

View Source

Specs

calendar_events_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) :: {:ok, nil} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}

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

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

      Whether to send notifications about the deletion of the event. 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 deletion of the event.

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

Returns

  • {:ok, %{}} on success
  • {:error, info} on failure