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

API calls for all endpoints tagged LiveChatMessages.

Link to this section Summary

Link to this section Functions

Link to this function

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

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

Deletes a chat message.

Parameters

  • connection (type: GoogleApi.YouTube.V3.Connection.t) - Connection to server
  • id (type: String.t) - The id parameter specifies the YouTube chat message ID of the resource that is being deleted.
  • 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_messages_insert(connection, part, optional_params \\ [], opts \\ [])

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

Adds a message to a live chat.

Parameters

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

Returns

  • {:ok, %GoogleApi.YouTube.V3.Model.LiveChatMessage{}} on success
  • {:error, info} on failure
Link to this function

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

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

Lists live chat messages for a specific chat.

Parameters

  • connection (type: GoogleApi.YouTube.V3.Connection.t) - Connection to server

  • live_chat_id (type: String.t) - The liveChatId parameter specifies the ID of the chat whose messages will be returned.

  • part (type: String.t) - The part parameter specifies the liveChatComment resource parts that the API response will include. Supported values are id and 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.

    • :hl (type: String.t) - The hl parameter instructs the API to retrieve localized resource metadata for a specific application language that the YouTube website supports. The parameter value must be a language code included in the list returned by the i18nLanguages.list method.

      If localized resource details are available in that language, the resource's snippet.localized object will contain the localized values. However, if localized details are not available, the snippet.localized object will contain resource details in the resource's default language.

    • :maxResults (type: integer()) - The maxResults parameter specifies the maximum number of messages 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 property identify other pages that could be retrieved.

    • :profileImageSize (type: integer()) - The profileImageSize parameter specifies the size of the user profile pictures that should be returned in the result set. Default: 88.

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

Returns

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