Automatically store Device and FCM Token information for Firebase Auth Users in Cloud Firestore
Automatically store Device and FCM Token information for Firebase Auth Users in Cloud Firestore.
This library is a proof of concept, and very much a work in progress.
Add FirebaseDeviceStore
to your Podfile
:
pod 'FirebaseDeviceStore'
Make sure you have use_frameworks!
enabled in your Podfile
Import the library:
import FirebaseDeviceStore
Initialise the library:
let deviceStore = FirebaseDeviceStore.init(app: FirebaseApp.app()!);
// Subscribe to the device store and ensure that appropriate notification permissions are granted
deviceStore.subscribe { (error) in
// Handle permission errors here
}
Import the library:
#import "FirebaseDeviceStore-Swift.h"
Initialise the library:
FirebaseDeviceStore *deviceStore = [[FirebaseDeviceStore alloc] initWithApp:[FIRApp defaultApp]];
// Subscribe to the device store and ensure that appropriate notification permissions are granted
[deviceStore subscribe:^(NSError * _Nullable error) {
// Handle permission errors here
}];
Firebase Device Store automatically stores device and FCM information for Firebase Auth users in Cloud Firestore.
A Document is created in the Cloud Firestore collection for each logged in user:
/user-devices
- userId1: {},
- userId2: {},
The structure of this Document is as follows:
{
devices: {
deviceId1: Device,
deviceId2: Device,
...
},
userId: string,
}
A Device
object contains the following:
{
deviceId: string, // A UUID for the device
fcmToken: string, // The FCM token
name: string, // The name of the device (e.g. 'Bob's iPhone')
os: string, // The OS of the device
type: 'iOS'
}
FirebaseDeviceStore.init(app: FIRApp, collectionPath: String?)
Create a new DeviceStore.
Parameters:
app
: FirebaseApp
(Optional) the Firebase App to use. Defaults to the default Firebase App.collectionPath
: (Optional) string
the Cloud Firestore collection where devices should be stored. Defaults to user-devices
.Returns a FirebaseDeviceStore
.
signOut(completion: (Error?) -> Void): void
Indicate to the DeviceStore that the user is about to sign out, and the current device token should be removed.
This can’t be done automatically with onAuthStateChanged
as the user is already signed out at this point. This means the Cloud Firestore security rules will prevent the database deletion as they no longer have the correct user permissions to remove the token.
Parameters:
completion
: (Error?) -> Void
a callback handler which will be called with an Error
if signing out wasn’t successful, or nil
otherwisesubscribe(completion: (Error?) -> Void): void
Subscribe a device store to the Firebase App. This will:
Parameters:
completion
: (Error?) -> Void
a callback handler which will be called with an Error
if the susbcription wasn’t successful, or nil
otherwiseunsubscribe(): void
Unsubscribe the device store from the Firebase App.
[FirebaseDeviceStore initWithApp: FIRApp collectionPath: NSString]
Create a new DeviceStore.
Parameters:
app
: FirebaseApp
(Optional) the Firebase App to use. Defaults to the default Firebase App.collectionPath
: (Optional) string
the Cloud Firestore collection where devices should be stored. Defaults to user-devices
.Returns a FirebaseDeviceStore
.
signOut:(void (^ _Nonnull)(NSError * _Nullable))completion: void
Indicate to the DeviceStore that the user is about to sign out, and the current device token should be removed.
This can’t be done automatically with onAuthStateChanged
as the user is already signed out at this point. This means the Cloud Firestore security rules will prevent the database deletion as they no longer have the correct user permissions to remove the token.
Parameters:
completion
: (void (^ _Nonnull)(NSError * _Nullable))
a callback handler which will return an Error
if signing out wasn’t successful, or nil
otherwisesubscribe:(void (^ _Nonnull)(NSError * _Nullable))completion: void
Subscribe a device store to the Firebase App. This will:
Parameters:
completion
: (void (^ _Nonnull)(NSError * _Nullable))
a callback handler which will return an Error
if the susbcription wasn’t successful, or nil
otherwiseunsubscribe: void
Unsubscribe the device store from the Firebase App.
You will need to add the following security rules for your Cloud Firestore collection:
service cloud.firestore {
match /databases/{database}/documents {
// Add this rule, replacing `user-devices` with the collection path you would like to use:
match /user-devices/{userId} {
allow create, read, update, delete: if request.auth.uid == userId;
}
}
}