GoogleApi.YouTube.V3.Api.LiveChatModerators (google_api_you_tube v0.54.0)

View Source

API calls for all endpoints tagged LiveChatModerators.

Summary

Functions

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

Deletes a chat moderator.

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

Inserts a new resource into this collection.

youtube_live_chat_moderators_list(connection, live_chat_id, part, optional_params \\ [], opts \\ [])

Retrieves a list of resources, possibly filtered.

Functions

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

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

Deletes a chat moderator.

Parameters

  • connection (type: GoogleApi.YouTube.V3.Connection.t) - Connection to server
  • id (type: String.t) -
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :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) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

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

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

@spec youtube_live_chat_moderators_insert(
  Tesla.Env.client(),
  [String.t()],
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.YouTube.V3.Model.LiveChatModerator.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Inserts a new resource into this collection.

Parameters

  • connection (type: GoogleApi.YouTube.V3.Connection.t) - Connection to server
  • part (type: list(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
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :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) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.YouTube.V3.Model.LiveChatModerator.t) -
  • opts (type: keyword()) - Call options

Returns

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

youtube_live_chat_moderators_list(connection, live_chat_id, part, optional_params \\ [], opts \\ [])

@spec youtube_live_chat_moderators_list(
  Tesla.Env.client(),
  String.t(),
  [String.t()],
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.YouTube.V3.Model.LiveChatModeratorListResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Retrieves a list of resources, possibly filtered.

Parameters

  • connection (type: GoogleApi.YouTube.V3.Connection.t) - Connection to server
  • live_chat_id (type: String.t) - The id of the live chat for which moderators should be returned.
  • part (type: list(String.t)) - The part parameter specifies the liveChatModerator resource parts that the API response will include. Supported values are id and snippet.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :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) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :maxResults (type: integer()) - The maxResults parameter specifies the maximum number of items that should be returned in the result set.
    • :pageToken (type: String.t) - The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved.
  • opts (type: keyword()) - Call options

Returns

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