Latest 0.0.1
Homepage https://github.com/csfrequency/firebase-device-store-ios-sdk
License Apache License, Version 2.0
Platforms ios 10.0
Dependencies Firebase/Core, Firebase/Auth, Firebase/Firestore, Firebase/Messaging
Authors

Firebase Device Store (iOS SDK)

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.

Installation

TODO

Example usage

TODO

Documentation

Firebase Device Store automatically stores device and FCM information for Firebase Auth users in Cloud Firestore.

Data Model

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: 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'
}

API

FirebaseDeviceStore(app, collectionPath)

Create a new DeviceStore.

Parameters:

  • app: FirebaseApp the Firebase App to use.
  • collectionPath: (Optional) string the Cloud Firestore collection where devices should be stored. Defaults to user-devices.

Returns a FirebaseDeviceStore.

FirebaseDeviceStore.signOut(): void

Indicate to the DeviceStore that the user is about to sign out, and the current device token should be removed.

This cannot be done automatically with onAuthStateChanged as the user won’t have permission to remove the token from Firestore as they are already signed out by this point and the Cloud Firestore security rules will prevent the database deletion.

FirebaseDeviceStore.subscribe(): void

Subscribe a device store to the Firebase App. This will:

  1. Subscribe to Firebase Auth and listen to changes in authentication state
  2. Subscribe to Firebase Messaging and listen to changes in the FCM token
  3. Automatically store device and FCM token information in the Cloud Firestore collection you specify

FirebaseDeviceStore.unsubscribe(): void

Unsubscribe the device store from the Firebase App.

Security rules

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;
    }
  }
}

Latest podspec

{
    "name": "FirebaseDeviceStore",
    "version": "0.0.1",
    "summary": "Automatically store Device and FCM token information for Firebase Auth users in Cloud Firestore.",
    "homepage": "https://github.com/csfrequency/firebase-device-store-ios-sdk",
    "license": "Apache License, Version 2.0",
    "authors": {
        "Chris Bianca": "[email protected]"
    },
    "platforms": {
        "ios": "10.0"
    },
    "swift_versions": "5.0",
    "source": {
        "git": "https://github.com/csfrequency/firebase-device-store-ios-sdk.git",
        "tag": "v0.0.1"
    },
    "source_files": "FirebaseDeviceStore/*.{h,swift}",
    "static_framework": true,
    "dependencies": {
        "Firebase/Core": [],
        "Firebase/Auth": [],
        "Firebase/Firestore": [],
        "Firebase/Messaging": []
    },
    "swift_version": "5.0"
}

Pin It on Pinterest

Share This