Class: Google::Apis::ChatV1::User

Inherits:
Object
  • Object
show all
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

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ User

Returns a new instance of User.



4186
4187
4188
 
# File 'lib/google/apis/chat_v1/classes.rb', line 4186

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

Returns:

  • (String) 


4151
4152
4153
 
# File 'lib/google/apis/chat_v1/classes.rb', line 4151

def display_name
  @display_name
end

#domain_id ⇒ String

Unique identifier of the user's Google Workspace domain. Corresponds to the JSON property domainId

Returns:

  • (String) 


4156
4157
4158
 
# File 'lib/google/apis/chat_v1/classes.rb', line 4156

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

Returns:

  • (Boolean) 


4161
4162
4163
 
# File 'lib/google/apis/chat_v1/classes.rb', line 4161

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: - theperson_idfor the [Person](https:// developers.google.com/people/api/rest/v1/people) in the People API, where the Person `resource_name` is `people/`person_id. For example, users/123456789 in Chat API represents the same person as people/123456789 in People API. - the id for a user 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 resourceName for user@example.com is people/ 123456789, you can use users/user@example.com as 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

Returns:

  • (String) 


4179
4180
4181
 
# File 'lib/google/apis/chat_v1/classes.rb', line 4179

def name
  @name
end

#type ⇒ String

User type. Corresponds to the JSON property type

Returns:

  • (String) 


4184
4185
4186
 
# File 'lib/google/apis/chat_v1/classes.rb', line 4184

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4191
4192
4193
4194
4195
4196
4197
 
# File 'lib/google/apis/chat_v1/classes.rb', line 4191

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