View Source GoogleApi.Chat.V1.Api.Users (google_api_chat v0.37.0)
API calls for all endpoints tagged Users
.
Summary
Functions
Returns details about a user's read state within a space, used to identify read and unread messages. For an example, see Get details about a user's space read state. Requires user authentication.
Returns details about a user's read state within a thread, used to identify read and unread messages. For an example, see Get details about a user's thread read state. Requires user authentication.
Updates a user's read state within a space, used to identify read and unread messages. For an example, see Update a user's space read state. Requires user authentication.
Functions
chat_users_spaces_get_space_read_state(connection, name, optional_params \\ [], opts \\ [])
View Source@spec chat_users_spaces_get_space_read_state( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Chat.V1.Model.SpaceReadState.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Returns details about a user's read state within a space, used to identify read and unread messages. For an example, see Get details about a user's space read state. Requires user authentication.
Parameters
-
connection
(type:GoogleApi.Chat.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Resource name of the space read state to retrieve. Only supports getting read state for the calling user. To refer to the calling user, set one of the following: - Theme
alias. For example,users/me/spaces/{space}/spaceReadState
. - Their Workspace email address. For example,users/user@example.com/spaces/{space}/spaceReadState
. - Their user id. For example,users/123456789/spaces/{space}/spaceReadState
. Format: users/{user}/spaces/{space}/spaceReadState -
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, %GoogleApi.Chat.V1.Model.SpaceReadState{}}
on success -
{:error, info}
on failure
chat_users_spaces_threads_get_thread_read_state(connection, name, optional_params \\ [], opts \\ [])
View Source@spec chat_users_spaces_threads_get_thread_read_state( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Chat.V1.Model.ThreadReadState.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Returns details about a user's read state within a thread, used to identify read and unread messages. For an example, see Get details about a user's thread read state. Requires user authentication.
Parameters
-
connection
(type:GoogleApi.Chat.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Resource name of the thread read state to retrieve. Only supports getting read state for the calling user. To refer to the calling user, set one of the following: - Theme
alias. For example,users/me/spaces/{space}/threads/{thread}/threadReadState
. - Their Workspace email address. For example,users/user@example.com/spaces/{space}/threads/{thread}/threadReadState
. - Their user id. For example,users/123456789/spaces/{space}/threads/{thread}/threadReadState
. Format: users/{user}/spaces/{space}/threads/{thread}/threadReadState -
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, %GoogleApi.Chat.V1.Model.ThreadReadState{}}
on success -
{:error, info}
on failure
chat_users_spaces_update_space_read_state(connection, name, optional_params \\ [], opts \\ [])
View Source@spec chat_users_spaces_update_space_read_state( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Chat.V1.Model.SpaceReadState.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates a user's read state within a space, used to identify read and unread messages. For an example, see Update a user's space read state. Requires user authentication.
Parameters
-
connection
(type:GoogleApi.Chat.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Resource name of the space read state. Format:users/{user}/spaces/{space}/spaceReadState
-
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"). -
:updateMask
(type:String.t
) - Required. The field paths to update. Currently supported field paths: -last_read_time
When thelast_read_time
is before the latest message create time, the space appears as unread in the UI. To mark the space as read, setlast_read_time
to any value later (larger) than the latest message create time. Thelast_read_time
is coerced to match the latest message create time. Note that the space read state only affects the read state of messages that are visible in the space's top-level conversation. Replies in threads are unaffected by this timestamp, and instead rely on the thread read state. -
:body
(type:GoogleApi.Chat.V1.Model.SpaceReadState.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Chat.V1.Model.SpaceReadState{}}
on success -
{:error, info}
on failure