public final class User extends GeneratedMessage implements UserOrBuilder
If your Chat app authenticates as a
user,
the output for a User resource (such as in the Messages and Memberships
APIs) only populates the name and type fields for both internal and
external users, unless they are members of the space or have prior affinity
with the calling user.
Protobuf type google.chat.v1.User
Inherited Members
com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)
com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)
com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)
com.google.protobuf.GeneratedMessage.canUseUnsafe()
com.google.protobuf.GeneratedMessage.emptyBooleanList()
com.google.protobuf.GeneratedMessage.emptyDoubleList()
com.google.protobuf.GeneratedMessage.emptyFloatList()
com.google.protobuf.GeneratedMessage.emptyIntList()
com.google.protobuf.GeneratedMessage.emptyLongList()
com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)
com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)
com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)
com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int)
Static Fields
AVATAR_URL_FIELD_NUMBER
public static final int AVATAR_URL_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DOMAIN_ID_FIELD_NUMBER
public static final int DOMAIN_ID_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
EMAIL_FIELD_NUMBER
public static final int EMAIL_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
IS_ANONYMOUS_FIELD_NUMBER
public static final int IS_ANONYMOUS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
TYPE_FIELD_NUMBER
public static final int TYPE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static User getDefaultInstance()
| Returns |
| Type |
Description |
User |
|
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static User.Builder newBuilder()
newBuilder(User prototype)
public static User.Builder newBuilder(User prototype)
| Parameter |
| Name |
Description |
prototype |
User
|
public static User parseDelimitedFrom(InputStream input)
| Returns |
| Type |
Description |
User |
|
public static User parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
User |
|
parseFrom(byte[] data)
public static User parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
| Returns |
| Type |
Description |
User |
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static User parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
User |
|
parseFrom(ByteString data)
public static User parseFrom(ByteString data)
| Returns |
| Type |
Description |
User |
|
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static User parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
User |
|
public static User parseFrom(CodedInputStream input)
| Returns |
| Type |
Description |
User |
|
public static User parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
User |
|
public static User parseFrom(InputStream input)
| Returns |
| Type |
Description |
User |
|
public static User parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
User |
|
parseFrom(ByteBuffer data)
public static User parseFrom(ByteBuffer data)
| Returns |
| Type |
Description |
User |
|
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static User parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
User |
|
parser()
public static Parser<User> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getAvatarUrl()
public 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 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.
|
getDefaultInstanceForType()
public User getDefaultInstanceForType()
| Returns |
| Type |
Description |
User |
|
getDisplayName()
public 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 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 String getDomainId()
Unique identifier of the user's Google Workspace domain.
string domain_id = 6;
| Returns |
| Type |
Description |
String |
The domainId.
|
getDomainIdBytes()
public ByteString getDomainIdBytes()
Unique identifier of the user's Google Workspace domain.
string domain_id = 6;
| Returns |
| Type |
Description |
ByteString |
The bytes for domainId.
|
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 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 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()
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.
string name = 1;
| Returns |
| Type |
Description |
String |
The name.
|
getNameBytes()
public 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
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.
string name = 1;
| Returns |
| Type |
Description |
ByteString |
The bytes for name.
|
getParserForType()
public Parser<User> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getType()
public User.Type getType()
User type.
.google.chat.v1.User.Type type = 5;
getTypeValue()
public int getTypeValue()
User type.
.google.chat.v1.User.Type type = 5;
| Returns |
| Type |
Description |
int |
The enum numeric value on the wire for type.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public User.Builder newBuilderForType()
newBuilderForType(AbstractMessage.BuilderParent parent)
protected User.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Overrides
toBuilder()
public User.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
