fcm-django Documentation

You can expose device management via DRF using two types of ViewSets:

1. FCMDeviceViewSet:

   • Uses standard DRF permissions.
   • Allows registering devices without an associated user.
   • Prevents duplicate registration_ids.

2. FCMDeviceAuthorizedViewSet:

   • Uses IsAuthenticated and a custom IsOwner permission.
   • Requires authentication; all devices must be associated with a user.
   • Updates the existing device if a duplicate registration_id is provided.

Routing Options

Using Routers (Full API):

from fcm_django.api.rest_framework import FCMDeviceAuthorizedViewSet
from rest_framework.routers import DefaultRouter

router = DefaultRouter()
router.register('devices', FCMDeviceAuthorizedViewSet)

urlpatterns = [
    path('', include(router.urls)),
]

Using as_view (Granular Control):

from fcm_django.api.rest_framework import FCMDeviceAuthorizedViewSet

urlpatterns = [
    path('devices', FCMDeviceAuthorizedViewSet.as_view({'post': 'create'}), name='create_fcm_device'),
    path('devices/<str:registration_id>', FCMDeviceAuthorizedViewSet.as_view({'delete': 'destroy'}), name='delete_fcm_device'),
]

To use fcm-django, add it to your INSTALLED_APPS and configure the FCM_DJANGO_SETTINGS dictionary. You must also ensure a Firebase app is initialized using firebase_admin.

from firebase_admin import initialize_app

INSTALLED_APPS = (
    ...
    "fcm_django"
    ...
)

# Initialize the Firebase app
FIREBASE_APP = initialize_app()

FCM_DJANGO_SETTINGS = {
     # An instance of firebase_admin.App to be used as default for all fcm-django requests
     # default: None (the default Firebase app)
    "DEFAULT_FIREBASE_APP": None,
     # default: _('FCM Django')
    "APP_VERBOSE_NAME": "[string for AppConfig's verbose_name]",
     # true if you want to have only one active device per registered user at a time
     # default: False
    "ONE_DEVICE_PER_USER": True,
     # devices to which notifications cannot be sent, are deleted upon receiving error response from FCM
     # default: False
    "DELETE_INACTIVE_DEVICES": True,
     # emit the ``device_deactivated`` signal when this library deactivates devices
     # default: False
    "EMIT_DEVICE_DEACTIVATED_SIGNAL": False,
}

If you need to store additional information or change the field types of the default FCMDevice model, you can override it by inheriting from AbstractFCMDevice.

To implement a custom model:

1. Create a new model in your app inheriting from AbstractFCMDevice.
2. Update your settings.py to point to your new model using the FCM_DJANGO_FCMDEVICE_MODEL setting.
3. Run makemigrations and migrate for your app.

Important Note on Database Tables: By default, both the package's original table and your custom table will exist in the database, but data will only appear in your custom table. To prevent the default fcm_django table from being created, remove "fcm_django" from INSTALLED_APPS in your settings.py (ensuring your own app remains in the list).

# your_app/models.py
import uuid
from django.db import models
from fcm_django.models import AbstractFCMDevice

class CustomDevice(AbstractFCMDevice):
    # Overwriting existing fields
    id = models.UUIDField(primary_key=True, default=uuid.uuid4, editable=False)
    # Adding new fields
    updated_at = models.DateTimeField(auto_now=True)

# settings.py
FCM_DJANGO_FCMDEVICE_MODEL = "your_app.CustomDevice"

To use fcm-django, add it to your INSTALLED_APPS and configure the FCM_DJANGO_SETTINGS dictionary in your settings.py. You should also initialize a Firebase app using firebase_admin.

from firebase_admin import initialize_app

INSTALLED_APPS = (
    ...
    "fcm_django"
    ...
)

# Initialize your firebase app
FIREBASE_APP = initialize_app()

FCM_DJANGO_SETTINGS = {
     # An instance of firebase_admin.App to be used as default for all fcm-django requests
     # default: None (the default Firebase app)
    "DEFAULT_FIREBASE_APP": None,
     # default: _('FCM Django')
    "APP_VERBOSE_NAME": "[string for AppConfig's verbose_name]",
     # true if you want to have only one active device per registered user at a time
     # default: False
    "ONE_DEVICE_PER_USER": True,
     # devices to which notifications cannot be sent, are deleted upon receiving error response from FCM
     # default: False
    "DELETE_INACTIVE_DEVICES": False,
}