Google Chat V1 API - Class Google::Apps::Chat::V1::User (v0.3.0)

Reference documentation and code samples for the Google Chat V1 API class Google::Apps::Chat::V1::User.

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.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#display_name

def display_name() -> ::String
Returns
  • (::String) — Output only. The user's display name.

#domain_id

def domain_id() -> ::String
Returns
  • (::String) — Unique identifier of the user's Google Workspace domain.

#domain_id=

def domain_id=(value) -> ::String
Parameter
  • value (::String) — Unique identifier of the user's Google Workspace domain.
Returns
  • (::String) — Unique identifier of the user's Google Workspace domain.

#is_anonymous

def is_anonymous() -> ::Boolean
Returns
  • (::Boolean) — Output only. When true, the user is deleted or their profile is not visible.

#name

def name() -> ::String
Returns
  • (::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, {user} is the same user identifier as:

    • the id for the Person 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 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.com is 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.

#name=

def name=(value) -> ::String
Parameter
  • value (::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, {user} is the same user identifier as:

    • the id for the Person 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 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.com is 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.

Returns
  • (::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, {user} is the same user identifier as:

    • the id for the Person 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 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.com is 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.

#type

def type() -> ::Google::Apps::Chat::V1::User::Type
Returns

#type=

def type=(value) -> ::Google::Apps::Chat::V1::User::Type
Parameter
Returns