GoogleApi.Chat.V1.Api.Users (google_api_chat v0.43.0)
View SourceAPI 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.
Gets the space notification setting. For an example, see Get the caller's space notification setting. Requires user authentication.
Updates the space notification setting. For an example, see Update the caller's space notification setting. 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
@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
@spec chat_users_spaces_space_notification_setting_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Chat.V1.Model.SpaceNotificationSetting.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets the space notification setting. For an example, see Get the caller's space notification setting. Requires user authentication.
Parameters
-
connection
(type:GoogleApi.Chat.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Format: users/{user}/spaces/{space}/spaceNotificationSetting -users/me/spaces/{space}/spaceNotificationSetting
, OR -users/user@example.com/spaces/{space}/spaceNotificationSetting
, OR -users/123456789/spaces/{space}/spaceNotificationSetting
. Note: Only the caller's user id or email is allowed in the path. -
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.SpaceNotificationSetting{}}
on success -
{:error, info}
on failure
@spec chat_users_spaces_space_notification_setting_patch( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Chat.V1.Model.SpaceNotificationSetting.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates the space notification setting. For an example, see Update the caller's space notification setting. Requires user authentication.
Parameters
-
connection
(type:GoogleApi.Chat.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Identifier. The resource name of the space notification setting. Format:users/{user}/spaces/{space}/spaceNotificationSetting
. -
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. Supported field paths: -notification_setting
-mute_setting
-
:body
(type:GoogleApi.Chat.V1.Model.SpaceNotificationSetting.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Chat.V1.Model.SpaceNotificationSetting{}}
on success -
{:error, info}
on failure
@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
@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