Class: Google::Apis::ChatV1::User
- Inherits:
-
Object
- Object
- Google::Apis::ChatV1::User
- Includes:
- Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
- Defined in:
- lib/google/apis/chat_v1/classes.rb,
lib/google/apis/chat_v1/representations.rb,
lib/google/apis/chat_v1/representations.rb
Overview
A user in Google Chat. When returned as an output from a request, if your Chat
app authenticates as a user, the output for a User
resource only
populates the user's name
and type
.
Instance Attribute Summary collapse
-
#display_name ⇒ String
Output only.
-
#domain_id ⇒ String
Unique identifier of the user's Google Workspace domain.
-
#is_anonymous ⇒ Boolean
(also: #is_anonymous?)
Output only.
-
#name ⇒ String
Resource name for a Google Chat user.
-
#type ⇒ String
User type.
Instance Method Summary collapse
-
#initialize(**args) ⇒ User
constructor
A new instance of User.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ User
Returns a new instance of User.
5447 5448 5449 |
# File 'lib/google/apis/chat_v1/classes.rb', line 5447 def initialize(**args) update!(**args) end |
Instance Attribute Details
#display_name ⇒ String
Output only. The user's display name.
Corresponds to the JSON property displayName
5413 5414 5415 |
# File 'lib/google/apis/chat_v1/classes.rb', line 5413 def display_name @display_name end |
#domain_id ⇒ String
Unique identifier of the user's Google Workspace domain.
Corresponds to the JSON property domainId
5418 5419 5420 |
# File 'lib/google/apis/chat_v1/classes.rb', line 5418 def domain_id @domain_id end |
#is_anonymous ⇒ Boolean Also known as: is_anonymous?
Output only. When true
, the user is deleted or their profile is not visible.
Corresponds to the JSON property isAnonymous
5423 5424 5425 |
# File 'lib/google/apis/chat_v1/classes.rb', line 5423 def is_anonymous @is_anonymous end |
#name ⇒ String
Resource name for a Google Chat user. Format: users/
user. `users/app` can
be used as an alias for the calling app bot user. For human users,
useris
the same user identifier as: - the `id` for the [Person](https://developers.
google.com/people/api/rest/v1/people) in the People API. For example, `users/
123456789` in Chat API represents the same person as the `123456789` Person
profile ID in People API. - the `id` for a [user](https://developers.google.
com/admin-sdk/directory/reference/rest/v1/users) in the Admin SDK Directory
API. - the user's email address can be used as an alias for
user`in API
requests. For example, if the People API Person profile ID for
user@example.
comis
123456789, you can use
users/user@example.comas an alias to
reference
users/123456789. Only the canonical resource name (for example
users/123456789) will be returned from the API.
Corresponds to the JSON property
name`
5440 5441 5442 |
# File 'lib/google/apis/chat_v1/classes.rb', line 5440 def name @name end |
#type ⇒ String
User type.
Corresponds to the JSON property type
5445 5446 5447 |
# File 'lib/google/apis/chat_v1/classes.rb', line 5445 def type @type end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
5452 5453 5454 5455 5456 5457 5458 |
# File 'lib/google/apis/chat_v1/classes.rb', line 5452 def update!(**args) @display_name = args[:display_name] if args.key?(:display_name) @domain_id = args[:domain_id] if args.key?(:domain_id) @is_anonymous = args[:is_anonymous] if args.key?(:is_anonymous) @name = args[:name] if args.key?(:name) @type = args[:type] if args.key?(:type) end |