Skip to content
T1KTheOneKit

t1k:unity:tof:firebase

FieldValue
Moduletof
Version2.2.2
Efforthigh
Tools—

Keywords: analytics, auth, crashlytics, firebase, remote-config, scriptable-object

How to invoke

Section titled “How to invoke”
/t1k:unity:tof:firebase

Firebase

Section titled “Firebase”

Purpose

Section titled “Purpose”

Firebase Authentication service providing sign-in methods and user management.

Public API

Section titled “Public API”

interface

  • ICloudFunctionsService (ICloudFunctionsService.cs)
  • IConverter (IConverter.cs)
  • IFirebaseAuthService (IFirebaseAuthService.cs)
  • IFirebaseDisposable (IFirebaseDisposable.cs)
  • IFirebaseInitializable (IFirebaseInitializable.cs)
  • IFirestoreProvider (IFirestoreProvider.cs)
  • IPlayerData (IPlayerData.cs) class
  • AuthStateChangedEventArgs (IFirebaseAuthService.cs)
  • ChangeMemberRoleMessageConverter (ChangeMemberRoleMessageConverter.cs)
  • CloudFunctionDataResponse (CloudFunctionModels.cs)
  • CloudFunctionException (ICloudFunctionsService.cs)
  • CloudFunctionNames (CloudFunctionModels.cs)
  • CloudFunctionResult (ICloudFunctionsService.cs)
  • CloudFunctionsConfig (CloudFunctionsConfig.cs)
  • CloudFunctionsValidator (CloudFunctionsValidator.cs)
  • CloudFunctionsVContainer (CloudFunctionsVContainer.cs)
  • CollectionHandler (CollectionHandler.cs)
  • CollectionParam (CollectionParam.cs)
  • DeleteGuildNotifyConverter (DeleteGuildNotifyConverter.cs)
  • DocumentParam (CollectionParam.cs)
  • DocumentSerializer (DocumentSerializer.cs)
  • FirebaseAuthResult (IFirebaseAuthService.cs)
  • FirebaseAuthService (FirebaseAuthService.cs)
  • FirebaseAuthValidator (FirebaseAuthValidator.cs)
  • FirebaseAuthVContainer (FirebaseAuthVContainer.cs)
  • FirebaseCoreValidator (FirebaseCoreValidator.cs)
  • FirebaseCoreVContainer (FirebaseCoreVContainer.cs)
  • FirebaseInitializationException (FirebaseInitializer.cs)
  • FirebaseInitializer (FirebaseInitializer.cs)
  • FirestoreConfig (FirestoreTaskExtensions.cs)
  • FirestoreCoreValidator (FirestoreCoreValidator.cs)
  • FirestoreCoreVContainer (FirestoreCoreVContainer.cs)
  • FirestoreGuildValidator (FirestoreGuildValidator.cs)
  • FirestoreGuildVContainer (FirestoreGuildVContainer.cs)
  • FirestoreListenerExtensions (FirestoreListenerExtensions.cs)
  • FirestoreLivesHelpValidator (FirestoreLivesHelpValidator.cs)
  • FirestoreLivesHelpVContainer (FirestoreLivesHelpVContainer.cs)
  • FirestoreOperationException (FirestoreTaskExtensions.cs)
  • FirestoreParam (FirestoreParam.cs)
  • FirestorePlayerValidator (FirestorePlayerValidator.cs)
  • FirestorePlayerVContainer (FirestorePlayerVContainer.cs)
  • FirestoreProvider (FirestoreProvider.cs)
  • FirestoreTaskExtensions (FirestoreTaskExtensions.cs)
  • FirestoreTimeoutException (FirestoreTaskExtensions.cs)
  • FirestoreWrapper (FirestoreWrapper.cs)
  • GetFirebaseTokenRequest (CloudFunctionModels.cs)
  • GetFirebaseTokenResponse (CloudFunctionModels.cs)
  • GuidProfileConverter (GuidProfileConverter.cs)
  • GuildChatService (GuildChatService.cs)
  • GuildDocument (GuildDocument.cs)
  • GuildPlayerData (GuildPlayerData.cs)
  • GuildPlayerDataConverter (GuildPlayerDataConverter.cs)
  • GuildService (GuildService.cs)
  • HttpCloudFunctionsService (HttpCloudFunctionsService.cs)
  • JoinRequest (GuildPlayerData.cs)
  • JoinRequestMessageConverter (JoinRequestMessageConverter.cs)
  • JoinResponseMessageConverter (JoinResponseMessageConverter.cs)
  • KickMemberMessageConverter (KickMemberMessageConverter.cs)
  • LivesHelpDataSyncService (LivesHelpDataSyncService.cs)
  • LivesHelpMessageConverter (LivesHelpMessageConverter.cs)
  • LivesPlayerData (LivesPlayerData.cs)
  • LivesPlayerDataConverter (LivesPlayerDataConverter.cs)
  • MemberEntryConverter (MemberEntryConverter.cs)
  • MemberJoinedMessageConverter (MemberJoinedMessageConverter.cs)
  • MemberLeftMessageConverter (MemberLeftMessageConverter.cs)
  • MessageConverter (MessageConverter.cs)
  • NetworkDebugConfig (NetworkDebugConfig.cs)
  • NetworkRetryableTask (FirestoreTaskExtensions.cs)
  • PlayerDataManager (PlayerDataManager.cs)
  • PlayerProfile (PlayerProfile.cs)
  • PlayerProfileConverter (PlayerProfileConverter.cs)
  • SdkCloudFunctionsService (SdkCloudFunctionsService.cs)
  • StickerMessageConverter (StickerMessageConverter.cs)
  • TextMessageConverter (TextMessageConverter.cs)

Signals / Events

Section titled “Signals / Events”

None detected.

Config / ScriptableObjects

Section titled “Config / ScriptableObjects”
  • CloudFunctionsConfig

Integration Steps

Section titled “Integration Steps”
  1. Reference package TheOneFeature in your project.
  2. Register the Firebase services via VContainer (see Architecture).
  3. Configure any ScriptableObjects listed in Config section.
  4. Subscribe to signals listed in Signals / Events to react to state changes.

Architecture

Section titled “Architecture”

Detected public types (74): interface

  • ICloudFunctionsService (ICloudFunctionsService.cs)
  • IConverter (IConverter.cs)
  • IFirebaseAuthService (IFirebaseAuthService.cs)
  • IFirebaseDisposable (IFirebaseDisposable.cs)
  • IFirebaseInitializable (IFirebaseInitializable.cs)
  • IFirestoreProvider (IFirestoreProvider.cs)
  • IPlayerData (IPlayerData.cs) class
  • AuthStateChangedEventArgs (IFirebaseAuthService.cs)
  • ChangeMemberRoleMessageConverter (ChangeMemberRoleMessageConverter.cs)
  • CloudFunctionDataResponse (CloudFunctionModels.cs)
  • CloudFunctionException (ICloudFunctionsService.cs)
  • CloudFunctionNames (CloudFunctionModels.cs)
  • CloudFunctionResult (ICloudFunctionsService.cs)
  • CloudFunctionsConfig (CloudFunctionsConfig.cs)
  • CloudFunctionsValidator (CloudFunctionsValidator.cs)
  • CloudFunctionsVContainer (CloudFunctionsVContainer.cs)
  • CollectionHandler (CollectionHandler.cs)
  • CollectionParam (CollectionParam.cs)
  • DeleteGuildNotifyConverter (DeleteGuildNotifyConverter.cs)
  • DocumentParam (CollectionParam.cs)
  • DocumentSerializer (DocumentSerializer.cs)
  • FirebaseAuthResult (IFirebaseAuthService.cs)
  • FirebaseAuthService (FirebaseAuthService.cs)
  • FirebaseAuthValidator (FirebaseAuthValidator.cs)
  • FirebaseAuthVContainer (FirebaseAuthVContainer.cs)
  • FirebaseCoreValidator (FirebaseCoreValidator.cs)
  • FirebaseCoreVContainer (FirebaseCoreVContainer.cs)
  • FirebaseInitializationException (FirebaseInitializer.cs)
  • FirebaseInitializer (FirebaseInitializer.cs)
  • FirestoreConfig (FirestoreTaskExtensions.cs)
  • FirestoreCoreValidator (FirestoreCoreValidator.cs)
  • FirestoreCoreVContainer (FirestoreCoreVContainer.cs)
  • FirestoreGuildValidator (FirestoreGuildValidator.cs)
  • FirestoreGuildVContainer (FirestoreGuildVContainer.cs)
  • FirestoreListenerExtensions (FirestoreListenerExtensions.cs)
  • FirestoreLivesHelpValidator (FirestoreLivesHelpValidator.cs)
  • FirestoreLivesHelpVContainer (FirestoreLivesHelpVContainer.cs)
  • FirestoreOperationException (FirestoreTaskExtensions.cs)
  • FirestoreParam (FirestoreParam.cs)
  • FirestorePlayerValidator (FirestorePlayerValidator.cs)
  • FirestorePlayerVContainer (FirestorePlayerVContainer.cs)
  • FirestoreProvider (FirestoreProvider.cs)
  • FirestoreTaskExtensions (FirestoreTaskExtensions.cs)
  • FirestoreTimeoutException (FirestoreTaskExtensions.cs)
  • FirestoreWrapper (FirestoreWrapper.cs)
  • GetFirebaseTokenRequest (CloudFunctionModels.cs)
  • GetFirebaseTokenResponse (CloudFunctionModels.cs)
  • GuidProfileConverter (GuidProfileConverter.cs)
  • GuildChatService (GuildChatService.cs)
  • GuildDocument (GuildDocument.cs)
  • GuildPlayerData (GuildPlayerData.cs)
  • GuildPlayerDataConverter (GuildPlayerDataConverter.cs)
  • GuildService (GuildService.cs)
  • HttpCloudFunctionsService (HttpCloudFunctionsService.cs)
  • JoinRequest (GuildPlayerData.cs)
  • JoinRequestMessageConverter (JoinRequestMessageConverter.cs)
  • JoinResponseMessageConverter (JoinResponseMessageConverter.cs)
  • KickMemberMessageConverter (KickMemberMessageConverter.cs)
  • LivesHelpDataSyncService (LivesHelpDataSyncService.cs)
  • LivesHelpMessageConverter (LivesHelpMessageConverter.cs)
  • LivesPlayerData (LivesPlayerData.cs)
  • LivesPlayerDataConverter (LivesPlayerDataConverter.cs)
  • MemberEntryConverter (MemberEntryConverter.cs)
  • MemberJoinedMessageConverter (MemberJoinedMessageConverter.cs)
  • MemberLeftMessageConverter (MemberLeftMessageConverter.cs)
  • MessageConverter (MessageConverter.cs)
  • NetworkDebugConfig (NetworkDebugConfig.cs)
  • NetworkRetryableTask (FirestoreTaskExtensions.cs)
  • PlayerDataManager (PlayerDataManager.cs)
  • PlayerProfile (PlayerProfile.cs)
  • PlayerProfileConverter (PlayerProfileConverter.cs)
  • SdkCloudFunctionsService (SdkCloudFunctionsService.cs)
  • StickerMessageConverter (StickerMessageConverter.cs)
  • TextMessageConverter (TextMessageConverter.cs)

Detected DI registrations:

  • FirebaseAuthService
  • FirebaseInitializer
  • FirestoreWrapper
  • GuildChatService
  • GuildService
  • GuildUtility
  • HttpCloudFunctionsService
  • LivesHelpDataSyncService
  • PlayerDataManager
  • SdkCloudFunctionsService

Dependencies

Section titled “Dependencies”

Run with FEATURE_MATRIX/DEPENDENCY_GRAPH integration to fill.

Gotchas

Section titled “Gotchas”

(None reported yet — open an issue in The1Studio/theonekit-unity if you hit one.)

References

Section titled “References”
  • Source: UnityTheOneFeatureProject/Packages/TheOneFeature/Core/Features/Firebase/
  • Doc: UnityTheOneFeatureProject/Packages/TheOneFeature/Core/Features/Firebase/Auth/README.md
  • Doc: UnityTheOneFeatureProject/Packages/TheOneFeature/Core/Features/Firebase/CloudFunctions/README.md
  • Doc: UnityTheOneFeatureProject/Packages/TheOneFeature/Core/Features/Firebase/Core/README.md
  • Doc: UnityTheOneFeatureProject/Packages/TheOneFeature/Core/Features/Firebase/Firestore/Core/README.md
  • Doc: UnityTheOneFeatureProject/Packages/TheOneFeature/Core/Features/Firebase/Firestore/Guild/README.md
  • Namespace: TheOne.Features.Firebase.Auth.DI, TheOne.Features.Firebase.Auth.Editor, TheOne.Features.Firebase.Auth, TheOne.Features.Firebase.CloudFunctions.DI, TheOne.Features.Firebase.CloudFunctions.Editor, TheOne.Features.Firebase.CloudFunctions, TheOne.Features.Firebase.Core.DI, TheOne.Features.Firebase.Core.Editor, TheOne.Features.Firebase.Core, TheOne.Features.Firestore.Core.DI, TheOne.Features.Firestore.Core.Editor, TheOne.Features.Firestore.Core, TheOne.Features.Firestore.Guild.DI, TheOne.Features.Firestore.Guild.Editor, TheOne.Features.Firestore.Guild, TheOne.Features.Firestore.LivesHelp.DI, TheOne.Features.Firestore.LivesHelp.Editor, TheOne.Features.Firestore.LivesHelp, TheOne.Features.Firestore.Player.DI, TheOne.Features.Firestore.Player.Editor, TheOne.Features.Firestore.Player