Class AuthEventData (0.16.0) 

public final class AuthEventData extends GeneratedMessageV3 implements AuthEventDataOrBuilder

The data within all Firebase Auth events.

Protobuf type google.events.firebase.auth.v1.AuthEventData

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > AuthEventData

Static Fields

CUSTOM_CLAIMS_FIELD_NUMBER

public static final int CUSTOM_CLAIMS_FIELD_NUMBER
Field Value
Type Description
int

DISABLED_FIELD_NUMBER

public static final int DISABLED_FIELD_NUMBER
Field Value
Type Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

EMAIL_FIELD_NUMBER

public static final int EMAIL_FIELD_NUMBER
Field Value
Type Description
int

EMAIL_VERIFIED_FIELD_NUMBER

public static final int EMAIL_VERIFIED_FIELD_NUMBER
Field Value
Type Description
int

METADATA_FIELD_NUMBER

public static final int METADATA_FIELD_NUMBER
Field Value
Type Description
int

PHONE_NUMBER_FIELD_NUMBER

public static final int PHONE_NUMBER_FIELD_NUMBER
Field Value
Type Description
int

PHOTO_URL_FIELD_NUMBER

public static final int PHOTO_URL_FIELD_NUMBER
Field Value
Type Description
int

PROVIDER_DATA_FIELD_NUMBER

public static final int PROVIDER_DATA_FIELD_NUMBER
Field Value
Type Description
int

UID_FIELD_NUMBER

public static final int UID_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static AuthEventData getDefaultInstance()
Returns
Type Description
AuthEventData

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static AuthEventData.Builder newBuilder()
Returns
Type Description
AuthEventData.Builder

newBuilder(AuthEventData prototype)

public static AuthEventData.Builder newBuilder(AuthEventData prototype)
Parameter
Name Description
prototype AuthEventData
Returns
Type Description
AuthEventData.Builder

parseDelimitedFrom(InputStream input)

public static AuthEventData parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AuthEventData
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AuthEventData parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AuthEventData
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static AuthEventData parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
AuthEventData
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static AuthEventData parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AuthEventData
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static AuthEventData parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
AuthEventData
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static AuthEventData parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AuthEventData
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static AuthEventData parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
AuthEventData
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static AuthEventData parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AuthEventData
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static AuthEventData parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AuthEventData
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AuthEventData parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AuthEventData
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static AuthEventData parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
AuthEventData
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static AuthEventData parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AuthEventData
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<AuthEventData> parser()
Returns
Type Description
Parser<AuthEventData>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getCustomClaims()

public Struct getCustomClaims()

User's custom claims, typically used to define user roles and propagated to an authenticated user's ID token.

.google.protobuf.Struct custom_claims = 10;

Returns
Type Description
Struct

The customClaims.

getCustomClaimsOrBuilder()

public StructOrBuilder getCustomClaimsOrBuilder()

User's custom claims, typically used to define user roles and propagated to an authenticated user's ID token.

.google.protobuf.Struct custom_claims = 10;

Returns
Type Description
StructOrBuilder

getDefaultInstanceForType()

public AuthEventData getDefaultInstanceForType()
Returns
Type Description
AuthEventData

getDisabled()

public boolean getDisabled()

Whether the user is disabled.

bool disabled = 6;

Returns
Type Description
boolean

The disabled.

getDisplayName()

public String getDisplayName()

The user's display name.

string display_name = 4;

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

The user's display name.

string display_name = 4;

Returns
Type Description
ByteString

The bytes for displayName.

getEmail()

public String getEmail()

The user's primary email, if set.

string email = 2;

Returns
Type Description
String

The email.

getEmailBytes()

public ByteString getEmailBytes()

The user's primary email, if set.

string email = 2;

Returns
Type Description
ByteString

The bytes for email.

getEmailVerified()

public boolean getEmailVerified()

Whether or not the user's primary email is verified.

bool email_verified = 3;

Returns
Type Description
boolean

The emailVerified.

getMetadata()

public UserMetadata getMetadata()

Additional metadata about the user.

.google.events.firebase.auth.v1.UserMetadata metadata = 7;

Returns
Type Description
UserMetadata

The metadata.

getMetadataOrBuilder()

public UserMetadataOrBuilder getMetadataOrBuilder()

Additional metadata about the user.

.google.events.firebase.auth.v1.UserMetadata metadata = 7;

Returns
Type Description
UserMetadataOrBuilder

getParserForType()

public Parser<AuthEventData> getParserForType()
Returns
Type Description
Parser<AuthEventData>
Overrides

getPhoneNumber()

public String getPhoneNumber()

The user's phone number.

string phone_number = 9;

Returns
Type Description
String

The phoneNumber.

getPhoneNumberBytes()

public ByteString getPhoneNumberBytes()

The user's phone number.

string phone_number = 9;

Returns
Type Description
ByteString

The bytes for phoneNumber.

getPhotoURL()

public String getPhotoURL()

The user's photo URL.

string photo_URL = 5;

Returns
Type Description
String

The photoURL.

getPhotoURLBytes()

public ByteString getPhotoURLBytes()

The user's photo URL.

string photo_URL = 5;

Returns
Type Description
ByteString

The bytes for photoURL.

getProviderData(int index)

public UserInfo getProviderData(int index)

User's info at the providers

repeated .google.events.firebase.auth.v1.UserInfo provider_data = 8;

Parameter
Name Description
index int
Returns
Type Description
UserInfo

getProviderDataCount()

public int getProviderDataCount()

User's info at the providers

repeated .google.events.firebase.auth.v1.UserInfo provider_data = 8;

Returns
Type Description
int

getProviderDataList()

public List<UserInfo> getProviderDataList()

User's info at the providers

repeated .google.events.firebase.auth.v1.UserInfo provider_data = 8;

Returns
Type Description
List<UserInfo>

getProviderDataOrBuilder(int index)

public UserInfoOrBuilder getProviderDataOrBuilder(int index)

User's info at the providers

repeated .google.events.firebase.auth.v1.UserInfo provider_data = 8;

Parameter
Name Description
index int
Returns
Type Description
UserInfoOrBuilder

getProviderDataOrBuilderList()

public List<? extends UserInfoOrBuilder> getProviderDataOrBuilderList()

User's info at the providers

repeated .google.events.firebase.auth.v1.UserInfo provider_data = 8;

Returns
Type Description
List<? extends com.google.events.firebase.auth.v1.UserInfoOrBuilder>

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getUid()

public String getUid()

The user identifier in the Firebase app.

string uid = 1;

Returns
Type Description
String

The uid.

getUidBytes()

public ByteString getUidBytes()

The user identifier in the Firebase app.

string uid = 1;

Returns
Type Description
ByteString

The bytes for uid.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
Type Description
UnknownFieldSet
Overrides

hasCustomClaims()

public boolean hasCustomClaims()

User's custom claims, typically used to define user roles and propagated to an authenticated user's ID token.

.google.protobuf.Struct custom_claims = 10;

Returns
Type Description
boolean

Whether the customClaims field is set.

hasMetadata()

public boolean hasMetadata()

Additional metadata about the user.

.google.events.firebase.auth.v1.UserMetadata metadata = 7;

Returns
Type Description
boolean

Whether the metadata field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public AuthEventData.Builder newBuilderForType()
Returns
Type Description
AuthEventData.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected AuthEventData.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
AuthEventData.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public AuthEventData.Builder toBuilder()
Returns
Type Description
AuthEventData.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException