google_api_you_tube v0.12.0 GoogleApi.YouTube.V3.Api.LiveChatBans View Source

API calls for all endpoints tagged LiveChatBans.

Link to this section Summary

Link to this section Functions

Link to this function

youtube_live_chat_bans_delete(connection, id, optional_params \\ [], opts \\ [])

View Source
youtube_live_chat_bans_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) :: {:ok, nil} | {:error, Tesla.Env.t()}

Removes a chat ban.

Parameters

  • connection (type: GoogleApi.YouTube.V3.Connection.t) - Connection to server
  • id (type: String.t) - The id parameter identifies the chat ban to remove. The value uniquely identifies both the ban and the chat.
  • 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.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %{}} on success
  • {:error, info} on failure
Link to this function

youtube_live_chat_bans_insert(connection, part, optional_params \\ [], opts \\ [])

View Source
youtube_live_chat_bans_insert(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) :: {:ok, GoogleApi.YouTube.V3.Model.LiveChatBan.t()} | {:error, Tesla.Env.t()}

Adds a new ban to the chat.

Parameters

  • connection (type: GoogleApi.YouTube.V3.Connection.t) - Connection to server
  • part (type: String.t) - The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response returns. Set the parameter value to snippet.
  • 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.
    • :body (type: GoogleApi.YouTube.V3.Model.LiveChatBan.t) -
  • opts (type: keyword()) - Call options

Returns

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