Firebase Unity API Reference

Firebase

Classes

AppOptionsOptions that control the creation of a Firebase App.
FirebaseAppFirebase application object.
FirebaseApp.EnableModuleParams
FirebaseExceptionException thrown for any Task exception.
InitializationExceptionThe exception that is thrown when a problem occurs with initialization of a Firebase module or class.

Firebase.AI

Classes

ChatAn object that represents a back-and-forth chat with a model, capturing the history and saving the context in memory between each message sent.
FirebaseAIThe entry point for all FirebaseAI SDK functionality.
FirebaseAI.BackendDefines which backend AI service is being used, provided to FirebaseAI.GetInstance.
GenerativeModelA type that represents a remote multimodal model (like Gemini), with the ability to generate content based on various input types.
LiveGenerativeModelA live, generative AI model for real-time interaction.
LiveSessionManages asynchronous communication with Gemini model over a WebSocket connection.
SchemaA Schema object allows the definition of input and output data types.
Schema.StringFormatModifiers describing the expected format of a string Schema.

Interfaces

ILiveSessionMessageRepresents a message received from a live session.

Structs

CandidateA struct representing a possible reply to a content generation prompt.
CitationA struct describing a source attribution.
CitationMetadataA collection of source attributions for a piece of content.
CountTokensResponseThe model's response to a count tokens request.
FunctionCallingConfigConfiguration for specifying function calling behavior.
FunctionDeclarationStructured representation of a function declaration.
GenerateContentResponseThe model's response to a generate content request.
GenerationConfigA struct defining model parameters to be used when sending generative AI requests to the backend model.
LiveGenerationConfigA struct defining model parameters to be used when generating live session content.
LiveSessionContentContent generated by the model in a live session.
LiveSessionResponseRepresents the response from the model for live content updates.
LiveSessionToolCallA request to use a tool from the live session.
LiveSessionToolCallCancellationA request to cancel using a tool from the live session.
ModalityTokenCountRepresents token counting info for a single modality.
ModelContentA type describing data in media formats interpretable by an AI model.
ModelContent.FileDataPartFile data stored in Cloud Storage for Firebase, referenced by a URI.
ModelContent.FunctionCallPartA predicted function call returned from the model.
ModelContent.FunctionResponsePartResult output from a function call.
ModelContent.InlineDataPartData with a specified media type.
ModelContent.PartA discrete piece of data in a media format interpretable by an AI model.
ModelContent.TextPartA text part containing a string value.
PromptFeedbackA metadata struct containing any feedback the model had on the prompt it was provided.
RequestOptionsConfiguration parameters for sending requests to the backend.
SafetyRatingA type defining potentially harmful media categories and their model-assigned ratings.
SafetySettingA type used to specify a threshold for harmful content, beyond which the model will return a fallback response instead of generated content.
SpeechConfigA struct used to configure speech generation settings.
ToolA helper tool that the model may use when generating responses.
ToolConfigTool configuration for any Tool specified in the request.
UsageMetadataToken usage metadata for processing the generate content request.

Firebase.Analytics

Classes

FirebaseAnalytics
ParameterEvent parameter.

Firebase.AppCheck

Classes

AppAttestProviderFactoryImplementation of an IAppCheckProviderFactory that builds providering using the App Attest service.
DebugAppCheckProviderFactoryImplementation of an IAppCheckProviderFactory that builds DebugAppCheckProviders.
DeviceCheckProviderFactoryImplementation of an IAppCheckProviderFactory that builds providering using the Device Check service.
FirebaseAppCheckFirebase App Check object.
PlayIntegrityProviderFactoryImplementation of an IAppCheckProviderFactory that builds providering using the Play Integrity service.
TokenChangedEventArgsPassed to the FirebaseAppCheck.TokenChanged event.

Interfaces

IAppCheckProviderInterface for a provider that generates AppCheckTokens.
IAppCheckProviderFactoryInterface for a factory that generates AppCheckProviders.

Structs

AppCheckTokenToken used by the Firebase App Check service.

Firebase.Auth

Classes

AdditionalUserInfoAdditional user data returned from an identity provider.
AuthResultThe result of operations that can affect authentication state.
CredentialAuthentication credentials for an authentication provider.
EmailAuthProviderUse email and password to authenticate.
FacebookAuthProviderUse an access token provided by Facebook to authenticate.
FederatedAuthProviderUsed to authenticate with Federated Auth Providers.
FederatedOAuthProviderAuthenticates with Federated OAuth Providers via the firebase::auth::Auth and firebase::auth::User classes.
FederatedOAuthProviderDataContains information to identify an OAuth povider.
FederatedProviderDataContains information required to authenticate with a third party provider.
FirebaseAccountLinkExceptionException thrown for failed Account Link Attempts.
FirebaseAuthFirebase authentication object.
FirebaseUserFirebase user account object.
ForceResendingTokenToken to maintain current phone number verification session.
GameCenterAuthProviderGameCenter (Apple) auth provider.
AuthProviderUse an access token provided by to authenticate.
GoogleAuthProviderUse an ID token and access token provided by Google to authenticate.
MicrosoftAuthProviderUse an access token provided by Microsoft to authenticate.
OAuthProviderOAuth2.0+UserInfo auth provider (OIDC compliant and non-compliant).
PhoneAuthCredentialWraps phone number and verification information for authentication purposes.
PhoneAuthOptionsOptions object for configuring phone validation flows in PhoneAuthProvider.
PhoneAuthProviderUse phone number text messages to authenticate.
PlayGamesAuthProviderUse a server auth code provided by Google Play Games to authenticate.
TwitterAuthProviderUse a token and secret provided by Twitter to authenticate.
UserInfoInterfaceInterface implemented by each identity provider.
UserMetadataMetadata corresponding to a Firebase user.
UserProfileParameters to the UpdateUserProfile() function.

Interfaces

IUserInfoInterface implemented by each identity provider.

Firebase.Crashlytics

Classes

CrashlyticsFirebaseCrashlytics API

Firebase.Database

Classes

ChildChangedEventArgsChild changed event arguments.
DatabaseErrorInstances of DatabaseError are passed within event arguments when an operation failed.
DatabaseExceptionThis error is thrown when the FirebaseDatabase library is unable to operate on the input it has been given.
DatabaseReferenceA Firebase reference represents a particular location in your FirebaseDatabase and can be used for reading or writing data to that FirebaseDatabase location.
DataSnapshotA DataSnapshot instance contains data from a FirebaseDatabase location.
FirebaseDatabaseThe entry point for accessing a FirebaseDatabase.
MutableDataInstances of this class encapsulate the data and priority at a location.
OnDisconnectThe OnDisconnect class is used to manage operations that will be Run on the server when this client disconnects.
QueryThe Query class (and its subclass, DatabaseReference ) are used for reading data.
ServerValueContains placeholder values to use when writing data to the FirebaseDatabase.
TransactionResultInstances of this class represent the desired outcome of a single Run of a transaction.
ValueChangedEventArgsEvent arguments passed with the Query.ValueChanged Event.

Classes

AndroidParametersAndroid Parameters.
DynamicLinkComponentsThe information needed to generate a Dynamic Link.
DynamicLinkOptionsAdditional options for Dynamic Link creation.
DynamicLinksFirebase Dynamic Links API.
GoogleAnalyticsParametersGoogle Analytics Parameters.
IOSParametersiOS Parameters.
ITunesConnectAnalyticsParametersiTunes Connect App Analytics Parameters.
ReceivedDynamicLinkThe received Dynamic Link.
ReceivedDynamicLinkEventArgsPassed to the DynamicLinks.DynamicLinkReceived event.
ShortDynamicLinkThe returned value from creating a shortened Dynamic Link.
SocialMetaTagParametersSocial meta-tag Parameters.

Firebase.Extensions

Classes

TaskExtensionExtension methods for System.Threading.Tasks.Task and System.Threading.Tasks.Task < T > that allow the continuation function to be executed on the main thread in Unity.

Firebase.Firestore

Classes

AggregateQueryA query that calculates aggregations over an underlying query.
AggregateQuerySnapshotThe results of executing an AggregateQuerySnapshot.
CollectionReferenceA reference to a collection in a Firestore database.
DocumentChangeA DocumentChange represents a change to the documents matching a query.
DocumentReferenceA DocumentReference refers to a document location in a Cloud Firestore database and can be used to write, read, or listen to the location.
DocumentSnapshotAn immutable snapshot of the data for a document.
FieldPathAn immutable path of field names, used to identify parts of a document.
FieldValueA static class providing properties and methods to represent sentinel values.
FilterA Filter represents a restriction on one or more field values and can be used to refine the results of a Query.
FirebaseFirestoreRepresents a Cloud Firestore database and is the entry point for all Cloud Firestore operations.
FirebaseFirestoreSettingsSettings used to configure a FirebaseFirestore instance.
FirestoreDataAttributeAttribute indicating that a type is intended to be used with Firestore.
FirestoreDocumentIdAttributeAttribute indicating that a property should be populated with the Firestore document ID.
FirestoreEnumNameConverter< T >Custom converter which uses enum value names instead of integer values as the Firestore representation.
FirestoreExceptionA class of exceptions thrown by Cloud Firestore.
FirestorePropertyAttributeAttribute indicating that a property should be included in Firestore conversions.
ListenerRegistrationRepresents a listener for either document or query snapshots that is returned from Listen methods.
LoadBundleTaskProgress
QueryA query which you can read or listen to.
QuerySnapshotA QuerySnapshot contains the results of a query.
ServerTimestampAttributeAttribute indicating that a timestamp property should be populated with a server timestamp.
SetOptionsAn options object that configures the behavior of SetAsync calls.
SnapshotMetadataMetadata about a snapshot, describing the state of the snapshot.
TransactionA transaction, as created by FirebaseFirestore.RunTransactionAsync{T}(System.Func{Transaction, Task{T}}) (and overloads) and passed to user code.
TransactionOptionsOptions to customize transaction behavior for FirebaseFirestore.RunTransactionAsync.
WriteBatchA batch of write operations, used to perform multiple writes as a single atomic unit.

Structs

BlobAn immutable sequence of bytes.
GeoPointImmutable struct representing a geographic location in Cloud Firestore.
TimestampA nanosecond-precision immutable timestamp.

Firebase.Functions

Classes

FirebaseFunctionsFirebaseFunctions is a service that supports calling Google Cloud Functions.
FunctionsExceptionRepresents an Exception resulting from an operation on a FunctionsReference
HttpsCallableReferenceRepresents a reference to a Google Cloud Functions HTTPS callable function.
HttpsCallableResult

Firebase.Installations

Classes

FirebaseInstallationsInstallations provides a unique identifier for each app instance and a mechanism to authenticate and authorize actions (for example, sending an FCM message).

Firebase.Messaging

Classes

AndroidNotificationParamsData structure for parameters that are unique to the Android implementation.
FirebaseMessageData structure used to send messages to, and receive messages from, cloud messaging.
FirebaseMessagingFirebase Cloud Messaging API.
FirebaseNotificationUsed for messages that display a notification.
MessageReceivedEventArgsEvent argument for the MessageReceived event containing the message data.
MessagingOptionsA class to configure the behavior of Firebase Cloud Messaging.
TokenReceivedEventArgsToken argument for the TokenReceived event containing the token string.

Firebase.RemoteConfig

Classes

ConfigInfoDescribes the state of the most recent Fetch() call.
ConfigUpdateEventArgs
FirebaseRemoteConfigEntry point for the Firebase C# SDK for Remote Config.

Structs

ConfigSettingsSettings for FirebaseRemoteConfig operations.
ConfigValueWrapper for a Remote Config parameter value, with methods to get it as different types, such as bools and doubles, along with information about where the data came from.

Firebase.Storage

Classes

DownloadStateDownloadState contains information for a download in progress.
FirebaseStorageFirebaseStorage is a service that supports uploading and downloading large objects to Google Cloud Storage.
MetadataChangeMetadataChange is a set of new metadata values used during object upload or when modifying the metadata of an object.
StorageExceptionRepresents an Exception resulting from an operation on a StorageReference
StorageMetadataMetadata for a StorageReference Metadata stores default attributes such as size and content type.
StorageProgress< T >A class that receives progress updates for storage uploads and downloads.
StorageReferenceRepresents a reference to a Google Cloud Storage object.
UploadStateUploadState contains information for an upload in progress.

Additional Resources

Modules

Analytics EventsPredefined event names.
Analytics ParametersPredefined event parameter names.
Analytics User PropertiesPredefined user property names.