google_api_you_tube v0.21.0 GoogleApi.YouTube.V3.Api.LiveChatMessages View Source
API calls for all endpoints tagged LiveChatMessages
.
Link to this section Summary
Functions
Deletes a chat message.
Inserts a new resource into this collection.
Retrieves a list of resources, possibly filtered.
Link to this section Functions
Link to this function
youtube_live_chat_messages_delete(connection, id, optional_params \\ [], opts \\ [])
View SourceSpecs
youtube_live_chat_messages_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, nil} | {:ok, Tesla.Env.t()} | {:error, any()}
Deletes a chat message.
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
Link to this function
youtube_live_chat_messages_insert(connection, part, optional_params \\ [], opts \\ [])
View SourceSpecs
youtube_live_chat_messages_insert( Tesla.Env.client(), [String.t()], keyword(), keyword() ) :: {:ok, GoogleApi.YouTube.V3.Model.LiveChatMessage.t()} | {:ok, Tesla.Env.t()} | {: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 <code><strong>part</strong></code> 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 <code>snippet</code>. -
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.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 SourceSpecs
youtube_live_chat_messages_list( Tesla.Env.client(), String.t(), [String.t()], keyword(), keyword() ) :: {:ok, GoogleApi.YouTube.V3.Model.LiveChatMessageListResponse.t()} | {:ok, Tesla.Env.t()} | {: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 comments should be returned. -
part
(type:list(String.t)
) - The <code><strong>part</strong></code> parameter specifies the <code>liveChatComment</code> resource parts that the API response will include. Supported values are <code>id</code> and <code>snippet</code>. -
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"). -
:hl
(type:String.t
) - Specifies the localization language in which the system messages should be returned. -
:maxResults
(type:integer()
) - The <code><strong>maxResults</strong></code> parameter specifies the maximum number of items that should be returned in the result set. -
:pageToken
(type:String.t
) - The <code><strong>pageToken</strong></code> parameter identifies a specific page in the result set that should be returned. In an API response, the <code>nextPageToken</code> property identify other pages that could be retrieved. -
:profileImageSize
(type:integer()
) - Specifies the size of the profile image that should be returned for each user.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.YouTube.V3.Model.LiveChatMessageListResponse{}}
on success -
{:error, info}
on failure