Class Index

A B C D E F G H I L M N O P Q R S T U V W

A

AbstractFirebaseAuth This is the abstract class for server-side Firebase Authentication actions. 
AbstractFirebaseAuth.Builder<T extends Builder<T>>  
ActionCodeSettings Defines the required continue/state URL with optional Android and iOS settings. 
ActionCodeSettings.Builder  
AndroidApp An instance of this class is a reference to an Android App within a Firebase Project; it can be used to query detailed information about the App, modify the display name of the App, or download the configuration file for the App. 
AndroidAppMetadata Contains detailed information about an Android App. 
AndroidConfig Represents the Android-specific options that can be included in a Message
AndroidConfig.Builder  
AndroidConfig.Priority Priority levels that can be set on an AndroidConfig
AndroidFcmOptions Represents the Android-specific FCM options that can be included in an AndroidConfig
AndroidFcmOptions.Builder  
AndroidNotification Represents the Android-specific notification options that can be included in a Message
AndroidNotification.Builder  
AndroidNotification.Priority  
AndroidNotification.Visibility  
ApnsConfig Represents the APNS-specific options that can be included in a Message
ApnsConfig.Builder  
ApnsFcmOptions Represents the APNS-specific FCM options that can be included in an ApnsConfig
ApnsFcmOptions.Builder  
Aps Represents the aps dictionary that is part of every APNS message. 
Aps.Builder  
ApsAlert Represents the alert property that can be included in the aps dictionary of an APNS payload. 
ApsAlert.Builder  
AuthErrorCode Error codes that can be raised by the Firebase Auth APIs. 

B

BatchResponse Response from an operation that sends FCM messages to multiple recipients. 
Bcrypt Represents the Bcrypt password hashing algorithm. 

C

ChildEventListener Classes implementing this interface can be used to receive events about changes in the child locations of a given DatabaseReference ref. 
Condition Represents a Remote Config condition that can be included in a Template
CriticalSound The sound configuration for APNs critical alerts. 
CriticalSound.Builder  

D

DatabaseError Instances of DatabaseError are passed to callbacks when an operation failed. 
DatabaseException This error is thrown when the Firebase Database library is unable to operate on the input it has been given. 
DatabaseReference A Firebase reference represents a particular location in your Database and can be used for reading or writing data to that Database location. 
DatabaseReference.CompletionListener This interface is used as a method of being notified when an operation has been acknowledged by the Database servers and can be considered complete 
DataSnapshot A DataSnapshot instance contains data from a Firebase Database location. 
DeleteUsersResult Represents the result of the deleteUsersAsync(List) API. 

E

EmailIdentifier Used for looking up an account by email. 
ErrorCode Platform-wide error codes that can be raised by Admin SDK APIs. 
ErrorInfo Represents an error encountered while importing an ImportUserRecord
Exclude Marks a field as excluded from the Database. 
ExportedUserRecord Contains metadata associated with a Firebase user account, along with password hash and salt. 

F

FcmOptions Represents the platform-independent FCM options that can be included in a Message
FcmOptions.Builder  
FirebaseApp The entry point of Firebase SDKs. 
FirebaseAuth This class is the entry point for all server-side Firebase Authentication actions. 
FirebaseAuthException Generic exception related to Firebase Authentication. 
FirebaseDatabase The entry point for accessing a Firebase Database. 
FirebaseException Base class for all Firebase exceptions. 
FirebaseInstanceId This class is the entry point for all server-side Firebase Instance ID actions. 
FirebaseInstanceIdException Represents an exception encountered while interacting with the Firebase instance ID service. 
FirebaseMessaging This class is the entry point for all server-side Firebase Cloud Messaging actions. 
FirebaseMessagingException  
FirebaseOptions Configurable Firebase options. 
FirebaseOptions.Builder Builder for constructing FirebaseOptions
FirebaseProjectManagement This class is the entry point for all Firebase Project Management actions. 
FirebaseProjectManagementException An exception encountered while interacting with the Firebase Project Management Service. 
FirebaseRemoteConfig This class is the entry point for all server-side Firebase Remote Config actions. 
FirebaseRemoteConfigException Generic exception related to Firebase Remote Config. 
FirebaseToken A decoded and verified Firebase token. 
FirestoreClient FirestoreClient provides access to Google Cloud Firestore. 

G

GenericTypeIndicator<T> Due to the way that Java implements generics (type-erasure), it is necessary to use a slightly more complicated method to properly resolve types for generic collections at runtime. 
GetUsersResult Represents the result of the getUsersAsync(Collection) API. 

H

HmacMd5 Represents the HMAC MD5 password hashing algorithm. 
HmacMd5.Builder  
HmacSha1 Represents the HMAC SHA1 password hashing algorithm. 
HmacSha1.Builder  
HmacSha256 Represents the HMAC SHA256 password hashing algorithm. 
HmacSha256.Builder  
HmacSha512 Represents the HMAC SHA512 password hashing algorithm. 
HmacSha512.Builder  

I

IgnoreExtraProperties Properties that don't map to class fields are ignored when serializing to a class annotated with this annotation. 
ImportUserRecord Represents a user account to be imported to Firebase Auth via the importUsers(List, UserImportOptions) API. 
ImportUserRecord.Builder  
IncomingHttpResponse Contains information that describes an HTTP response received by the SDK. 
IosApp An instance of this class is a reference to an iOS App within a Firebase Project; it can be used to query detailed information about the App, modify the display name of the App, or download the configuration file for the App. 
IosAppMetadata Contains detailed information about an iOS App. 

L

LightSettings A class representing light settings in an Android Notification. 
LightSettings.Builder  
LightSettingsColor A class representing color in LightSettings. 
ListProviderConfigsPage<T extends ProviderConfig> Represents a page of ProviderConfig instances. 
ListTenantsPage Represents a page of Tenant instances. 
ListUsersPage Represents a page of ExportedUserRecord instances. 
ListVersionsOptions A class representing options for Remote Config list versions operation. 
ListVersionsOptions.Builder  
ListVersionsPage Represents a page of Version instances. 

M

Md5 Represents the MD5 password hashing algorithm. 
Md5.Builder  
Message Represents a message that can be sent via Firebase Cloud Messaging (FCM). 
Message.Builder  
MessagingErrorCode Error codes that can be raised by the Cloud Messaging APIs. 
MulticastMessage Represents a message that can be sent to multiple devices via Firebase Cloud Messaging (FCM). 
MulticastMessage.Builder  
MutableData Instances of this class encapsulate the data and priority at a location. 

N

Notification Represents the notification parameters that can be included in a Message
Notification.Builder  

O

OidcProviderConfig Contains metadata associated with an OIDC Auth provider. 
OidcProviderConfig.CreateRequest A specification class for creating a new OIDC Auth provider. 
OidcProviderConfig.UpdateRequest A specification class for updating an existing OIDC Auth provider. 
OnDisconnect The OnDisconnect class is used to manage operations that will be run on the server when this client disconnects. 
OutgoingHttpRequest Contains the information that describe an HTTP request made by the SDK. 

P

Parameter Represents a Remote Config parameter that can be included in a Template
ParameterGroup Represents a Remote Config parameter group that can be included in a Template
ParameterValue Represents a Remote Config parameter value that can be used in a Template
ParameterValue.Explicit Represents an explicit Remote Config parameter value with a value that the parameter is set to. 
ParameterValue.InAppDefault Represents an in app default parameter value. 
ParameterValueType Data types that are associated with parameter values. 
Pbkdf2Sha256 Represents the PBKDF2 SHA256 password hashing algorithm. 
Pbkdf2Sha256.Builder  
PbkdfSha1 Represents the PBKDF SHA1 password hashing algorithm. 
PbkdfSha1.Builder  
PhoneIdentifier Used for looking up an account by phone number. 
PropertyName Marks a field to be renamed when serialized. 
ProviderConfig The base class for Auth providers. 
ProviderConfig.AbstractCreateRequest<T extends AbstractCreateRequest<T>> A base specification class for creating a new provider. 
ProviderConfig.AbstractUpdateRequest<T extends AbstractUpdateRequest<T>> A base class for updating the attributes of an existing provider. 
ProviderIdentifier Used for looking up an account by provider. 

Q

Query The Query class (and its subclass, DatabaseReference) are used for reading data. 

R

RemoteConfigErrorCode Error codes that can be raised by the Remote Config APIs. 

S

SamlProviderConfig Contains metadata associated with a SAML Auth provider. 
SamlProviderConfig.CreateRequest A specification class for creating a new SAML Auth provider. 
SamlProviderConfig.UpdateRequest A specification class for updating an existing SAML Auth provider. 
Scrypt Represents the Scrypt password hashing algorithm. 
Scrypt.Builder  
SendResponse The result of an individual send operation that was executed as part of a batch. 
ServerValue Contains placeholder values to use when writing data to the Firebase Database. 
SessionCookieOptions A set of additional options that can be passed to createSessionCookieAsync(String, SessionCookieOptions)
SessionCookieOptions.Builder  
Sha1 Represents the SHA1 password hashing algorithm. 
Sha1.Builder  
Sha256 Represents the SHA256 password hashing algorithm. 
Sha256.Builder  
Sha512 Represents the SHA512 password hashing algorithm. 
Sha512.Builder  
ShaCertificate Information about an SHA certificate associated with an Android app. 
ShaCertificateType Enum denoting types of SHA certificates currently supported by Firebase. 
StandardScrypt Represents the Standard Scrypt password hashing algorithm. 
StandardScrypt.Builder  
StorageClient StorageClient provides access to Google Cloud Storage APIs. 

T

TagColor Colors that are associated with conditions for display purposes in the Firebase Console. 
Template Represents a Remote Config template. 
Tenant Contains metadata associated with a Firebase tenant. 
Tenant.CreateRequest A specification class for creating a new tenant. 
Tenant.UpdateRequest A class for updating the attributes of an existing tenant. 
TenantAwareFirebaseAuth The tenant-aware Firebase client. 
TenantManager This class can be used to perform a variety of tenant-related operations, including creating, updating, and listing tenants. 
ThreadManager An interface that controls the thread pools and thread factories used by the Admin SDK. 
ThrowOnExtraProperties Properties that don't map to class fields when serializing to a class annotated with this annotation cause an exception to be thrown. 
TopicManagementResponse The response produced by FCM topic management operations. 
TopicManagementResponse.Error A topic management error. 
Transaction The Transaction class encapsulates the functionality needed to perform a transaction on the data at a location. 
Transaction.Handler An object implementing this interface is used to run a transaction, and will be notified of the results of the transaction. 
Transaction.Result Instances of this class represent the desired outcome of a single run of a Transaction.Handler's doTransaction method. 

U

UidIdentifier Used for looking up an account by uid. 
User Represents a Remote Config user. 
UserIdentifier Identifies a user to be looked up. 
UserImportHash Represents a hash algorithm and the related configuration parameters used to hash user passwords. 
UserImportOptions A collection of options that can be passed to the importUsersAsync(List, UserImportOptions) API. 
UserImportOptions.Builder  
UserImportResult Represents the result of the importUsersAsync(List, UserImportOptions) API. 
UserInfo A collection of standard profile information for a user. 
UserMetadata Contains additional metadata associated with a user account. 
UserProvider Represents a user identity provider that can be associated with a Firebase user. 
UserProvider.Builder  
UserRecord Contains metadata associated with a Firebase user account. 
UserRecord.CreateRequest A specification class for creating new user accounts. 
UserRecord.UpdateRequest A class for updating the attributes of an existing user. 

V

ValueEventListener Classes implementing this interface can be used to receive events about data changes at a location. 
Version Represents a Remote Config template version. 

W

WebpushConfig Represents the Webpush protocol options that can be included in a Message
WebpushConfig.Builder  
WebpushFcmOptions Represents options for features provided by the FCM SDK for Web. 
WebpushFcmOptions.Builder  
WebpushNotification Represents the Webpush-specific notification options that can be included in a Message
WebpushNotification.Action Represents an action available to users when the notification is presented. 
WebpushNotification.Builder  
WebpushNotification.Direction Different directions a notification can be displayed in.