Interface UserOrBuilder (0.63.0)

0.63.0 (latest) 0.59.0 0.58.0 0.57.0 0.55.0 0.52.0 0.51.0 0.49.0 0.47.0 0.46.0 0.45.0 0.44.0 0.42.0 0.40.0 0.39.0 0.38.0 0.37.0 0.36.0 0.34.0 0.32.0 0.31.0 0.28.0 0.27.0 0.26.0 0.24.0 0.23.0 0.22.0 0.21.0 0.20.0 0.19.0 0.18.0 0.17.0 0.16.0 0.15.0 0.13.0 0.12.0 0.11.0 0.10.0 0.9.0 0.8.0 0.7.0 0.6.0 0.5.0 0.4.0 0.3.0 0.1.0

public interface UserOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAvatarUrl()

public abstract String getAvatarUrl()

Output only. The user's avatar image URL.

When calling the Messages and Memberships APIs with user authentication, this field is populated for both internal and external users for the sender of a message, users within annotations (such as user mentions), and within Membership resources, provided the user is a member of the space or has prior affinity with the calling user.

string avatar_url = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
String	The avatarUrl.

getAvatarUrlBytes()

public abstract ByteString getAvatarUrlBytes()

Output only. The user's avatar image URL.

When calling the Messages and Memberships APIs with user authentication, this field is populated for both internal and external users for the sender of a message, users within annotations (such as user mentions), and within Membership resources, provided the user is a member of the space or has prior affinity with the calling user.

string avatar_url = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ByteString	The bytes for avatarUrl.

getDisplayName()

public abstract String getDisplayName()

Output only. The user's display name.

Populated for both app authentication and user authentication. This field is always populated for requests made with app authentication. When calling the Messages and Memberships APIs with user authentication, this field is populated for both internal and external users for the sender of a message, users within annotations (such as user mentions), and within Membership resources, provided the user is a member of the space or has prior affinity with the calling user.

string display_name = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
String	The displayName.

getDisplayNameBytes()

public abstract ByteString getDisplayNameBytes()

Output only. The user's display name.

Populated for both app authentication and user authentication. This field is always populated for requests made with app authentication. When calling the Messages and Memberships APIs with user authentication, this field is populated for both internal and external users for the sender of a message, users within annotations (such as user mentions), and within Membership resources, provided the user is a member of the space or has prior affinity with the calling user.

string display_name = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ByteString	The bytes for displayName.

getDomainId()

public abstract String getDomainId()

Unique identifier of the user's Google Workspace domain.

string domain_id = 6;

Returns
Type	Description
String	The domainId.

getDomainIdBytes()

public abstract ByteString getDomainIdBytes()

Unique identifier of the user's Google Workspace domain.

string domain_id = 6;

Returns
Type	Description
ByteString	The bytes for domainId.

getEmail()

public abstract String getEmail()

Output only. The user's email address.

When calling the Messages and Memberships APIs with user authentication, this field is populated for both internal and external users for the sender of a message, users within annotations (such as user mentions), and within Membership resources, provided the user is a member of the space or has prior affinity with the calling user.

string email = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
String	The email.

getEmailBytes()

public abstract ByteString getEmailBytes()

Output only. The user's email address.

When calling the Messages and Memberships APIs with user authentication, this field is populated for both internal and external users for the sender of a message, users within annotations (such as user mentions), and within Membership resources, provided the user is a member of the space or has prior affinity with the calling user.

string email = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ByteString	The bytes for email.

getIsAnonymous()

public abstract boolean getIsAnonymous()

Output only. When true, the user is deleted or their profile is not visible, such as when a user is mentioned in a space without being a member and without prior affinity with the calling user.

bool is_anonymous = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	The isAnonymous.

getName()

public abstract String getName()

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

string name = 1;

Returns
Type	Description
String	The name.

getNameBytes()

public abstract ByteString getNameBytes()

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

string name = 1;

Returns
Type	Description
ByteString	The bytes for name.

getType()

public abstract User.Type getType()

User type.

.google.chat.v1.User.Type type = 5;

Returns
Type	Description
User.Type	The type.

getTypeValue()

public abstract int getTypeValue()

User type.

.google.chat.v1.User.Type type = 5;

Returns
Type	Description
int	The enum numeric value on the wire for type.