Class: Google::Apps::Chat::V1::User

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/chat/v1/user.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.

Defined Under Namespace

Modules: Type

Instance Attribute Summary collapse

Instance Attribute Details

#display_name ⇒ ::String (readonly)

Returns Output only. The user's display name.

Returns:

  • (::String) —

    Output only. The user's display name.



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'proto_docs/google/chat/v1/user.rb', line 66

class User
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  module Type
    # Default value for the enum. DO NOT USE.
    TYPE_UNSPECIFIED = 0

    # Human user.
    HUMAN = 1

    # Chat app user.
    BOT = 2
  end
end

#domain_id ⇒ ::String

Returns Unique identifier of the user's Google Workspace domain.

Returns:

  • (::String) —

    Unique identifier of the user's Google Workspace domain.



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'proto_docs/google/chat/v1/user.rb', line 66

class User
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  module Type
    # Default value for the enum. DO NOT USE.
    TYPE_UNSPECIFIED = 0

    # Human user.
    HUMAN = 1

    # Chat app user.
    BOT = 2
  end
end

#is_anonymous ⇒ ::Boolean (readonly)

Returns Output only. When true, the user is deleted or their profile is not visible.

Returns:

  • (::Boolean) —

    Output only. When true, the user is deleted or their profile is not visible.



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'proto_docs/google/chat/v1/user.rb', line 66

class User
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  module Type
    # Default value for the enum. DO NOT USE.
    TYPE_UNSPECIFIED = 0

    # Human user.
    HUMAN = 1

    # Chat app user.
    BOT = 2
  end
end

#name ⇒ ::String

Returns 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 [email protected] is 123456789, you can use users/[email protected] 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 [email protected] is 123456789, you can use users/[email protected] as an alias to reference users/123456789. Only the canonical resource name (for example users/123456789) will be returned from the API.



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'proto_docs/google/chat/v1/user.rb', line 66

class User
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  module Type
    # Default value for the enum. DO NOT USE.
    TYPE_UNSPECIFIED = 0

    # Human user.
    HUMAN = 1

    # Chat app user.
    BOT = 2
  end
end

#type ⇒ ::Google::Apps::Chat::V1::User::Type

Returns User type.

Returns:



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'proto_docs/google/chat/v1/user.rb', line 66

class User
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  module Type
    # Default value for the enum. DO NOT USE.
    TYPE_UNSPECIFIED = 0

    # Human user.
    HUMAN = 1

    # Chat app user.
    BOT = 2
  end
end