FCM Django

https://github.com/xtrinch/fcm-django
Admin
FCM Django is a Django app that allows you to send push notifications to Android devices using...
Tokens:7,689
Snippets:47
Trust Score:9.8
License:MIT
Update:1 year ago
Show doc for...
Tokens:
Raw
### Install fcm-django

Source: https://github.com/xtrinch/fcm-django/blob/master/README.rst

Provides the command to install the fcm-django library using pip, the standard package installer for Python.

```console
pip install fcm-django
```

--------------------------------

### Setting up Development Environment for fcm-django

Source: https://github.com/xtrinch/fcm-django/blob/master/README.rst

Instructions for setting up a local development environment for fcm-django. This includes creating and activating a virtual environment, installing development dependencies, and running pre-commit hooks.

```console
python3 -m venv env
source env/bin/activate
pip install -r requirements_dev.txt
pre-commit run --all-files
```

--------------------------------

### Install fcm-django

Source: https://github.com/xtrinch/fcm-django/blob/master/docs/index.rst

Provides the command to install the fcm-django library using pip, the standard package installer for Python.

```console
pip install fcm-django
```

--------------------------------

### Running Django Tests with Custom Settings

Source: https://github.com/xtrinch/fcm-django/blob/master/README.rst

This example demonstrates how to run Django tests using pytest, specifying different settings modules for default or swapped models. It also shows how to set the DATABASE_URL environment variable to test migrations against various databases.

```console
export DATABASE_URL=postgres://postgres:postgres@127.0.0.1:5432/postgres
export DJANGO_SETTINGS_MODULE=tests.settings.default 
# or export DJANGO_SETTINGS_MODULE=tests.settings.swap
pytest
```

--------------------------------

### Send FCM Messages in Bulk to Devices

Source: https://github.com/xtrinch/fcm-django/blob/master/README.rst

Provides examples for sending FCM messages in bulk to multiple devices. This includes sending to a queryset of devices or using the `send_message` method on the queryset itself.

```python
from firebase_admin.messaging import Message
from fcm_django.models import FCMDevice

devices = FCMDevice.objects.all()
devices.send_message(Message(data={...}))
# Or (send_message parameters include: messages, dry_run, app)
FCMDevice.objects.send_message(Message(...))
```

--------------------------------

### Custom FCMDevice Model for MySQL

Source: https://github.com/xtrinch/fcm-django/blob/master/docs/index.rst

An example of a custom FCMDevice model that extends AbstractFCMDevice. This custom model defines a CharField for registration_id with a max_length of 600, allowing it to be unique and indexed even with MySQL.

```python
from fcm_django.models import AbstractFCMDevice, FCMDevice as OriginalFCMDevice


class CustomFCMDevice(AbstractFCMDevice):
    registration_id = models.CharField(
        verbose_name="Registration token",
        unique=True,
        max_length=600,  # https://stackoverflow.com/a/64902685 better to be safe than sorry
    )

    class Meta(OriginalFCMDevice.Meta):
        pass
```

--------------------------------

### Packaging fcm-django for PyPi

Source: https://github.com/xtrinch/fcm-django/blob/master/README.rst

Steps to package the fcm-django library for distribution on PyPi. This involves activating the virtual environment, cleaning the dist directory, creating a source distribution, and uploading the package using twine.

```console
source env/bin/activate
rm -rf dist/
python3 setup.py sdist
twine upload dist/*
```

--------------------------------

### Running Development Tests with MySQL

Source: https://github.com/xtrinch/fcm-django/blob/master/docs/index.rst

Console commands to set up the environment for running fcm-django development tests, specifically when targeting a MySQL database. This involves exporting environment variables for the database URL and Django settings module.

```console
export DATABASE_URL=postgres://postgres:postgres@127.0.0.1:5432/postgres
export DJANGO_SETTINGS_MODULE=tests.settings.default
# or export DJANGO_SETTINGS_MODULE=tests.settings.swap
pytest
```

--------------------------------

### Initialize Firebase Apps in Django Settings

Source: https://github.com/xtrinch/fcm-django/blob/master/README.rst

Demonstrates how to initialize default and custom Firebase apps using credentials, including a custom Credentials class for non-default service accounts. This is crucial for setting up FCM messaging.

```python
from firebase_admin import initialize_app, credentials
from google.auth import load_credentials_from_file
from google.oauth2.service_account import Credentials
import os

# create a custom Credentials class to load a non-default google service account JSON
class CustomFirebaseCredentials(credentials.ApplicationDefault):
    def __init__(self, account_file_path: str):
        super().__init__()
        self._account_file_path = account_file_path

    def _load_credential(self):
        if not self._g_credential:
            self._g_credential, self._project_id = load_credentials_from_file(self._account_file_path,
                                                                              scopes=credentials._scopes)

# init default firebase app
# this loads the default google service account with GOOGLE_APPLICATION_CREDENTIALS env variable
FIREBASE_APP = initialize_app()

# init second firebase app for fcm-django
# the environment variable contains a path to the custom google service account JSON
custom_credentials = CustomFirebaseCredentials(os.getenv('CUSTOM_GOOGLE_APPLICATION_CREDENTIALS'))
FIREBASE_MESSAGING_APP = initialize_app(custom_credentials, name='messaging')

FCM_DJANGO_SETTINGS = {
    "DEFAULT_FIREBASE_APP": FIREBASE_MESSAGING_APP,
    # [...] your other settings
}
```

--------------------------------

### Initialize Firebase Apps with Custom Credentials in Python

Source: https://github.com/xtrinch/fcm-django/blob/master/docs/index.rst

Demonstrates how to initialize default and custom Firebase apps using service account credentials. It includes a custom Credentials class to load non-default Google service account JSON files and sets up a separate app for messaging.

```python
from firebase_admin import initialize_app, credentials
from google.auth import load_credentials_from_file
from google.oauth2.service_account import Credentials
import os

# create a custom Credentials class to load a non-default google service account JSON
class CustomFirebaseCredentials(credentials.ApplicationDefault):
    def __init__(self, account_file_path: str):
        super().__init__()
        self._account_file_path = account_file_path

    def _load_credential(self):
        if not self._g_credential:
            self._g_credential, self._project_id = load_credentials_from_file(self._account_file_path,
                                                                              scopes=credentials._scopes)

# init default firebase app
# this loads the default google service account with GOOGLE_APPLICATION_CREDENTIALS env variable
FIREBASE_APP = initialize_app()

# init second firebase app for fcm-django
# the environment variable contains a path to the custom google service account JSON
custom_credentials = CustomFirebaseCredentials(os.getenv('CUSTOM_GOOGLE_APPLICATION_CREDENTIALS'))
FIREBASE_MESSAGING_APP = initialize_app(custom_credentials, name='messaging')

FCM_DJANGO_SETTINGS = {
    "DEFAULT_FIREBASE_APP": FIREBASE_MESSAGING_APP,
    # [...] your other settings
}
```

--------------------------------

### Initialize Firebase App in Django Settings

Source: https://github.com/xtrinch/fcm-django/blob/master/docs/index.rst

Demonstrates how to initialize the Firebase Admin SDK within a Django project's settings.py file. This is necessary for fcm-django to communicate with Firebase Cloud Messaging. It requires setting the GOOGLE_APPLICATION_CREDENTIALS environment variable.

```python
from firebase_admin import initialize_app
FIREBASE_APP = initialize_app()
# Or just
initialize_app()
```

--------------------------------

### Subscribe/Unsubscribe Users to FCM Topic

Source: https://github.com/xtrinch/fcm-django/blob/master/README.rst

Demonstrates how to subscribe or unsubscribe devices to an FCM topic using the `handle_topic_subscription` method on a single device or a queryset.

```python
from fcm_django.models import FCMDevice

# Subscribing
FCMDevice.objects.all().handle_topic_subscription(True, topic="TOPIC NAME"))
device = FCMDevice.objects.all().first()
device.handle_topic_subscription(True, topic="TOPIC NAME"))

# Unsubscribing
FCMDevice.objects.all().handle_topic_subscription(False, topic="TOPIC NAME"))
device = FCMDevice.objects.all().first()
device.handle_topic_subscription(False, topic="TOPIC NAME"))
```

--------------------------------

### Initialize Firebase App in Django Settings

Source: https://github.com/xtrinch/fcm-django/blob/master/README.rst

Demonstrates how to initialize the Firebase Admin SDK within a Django project's settings.py file. This is necessary for fcm-django to communicate with Firebase Cloud Messaging. It requires setting the GOOGLE_APPLICATION_CREDENTIALS environment variable.

```python
from firebase_admin import initialize_app
FIREBASE_APP = initialize_app()
# Or just
initialize_app()
```

--------------------------------

### DRF: Register FCMDeviceViewSet using as_view

Source: https://github.com/xtrinch/fcm-django/blob/master/README.rst

Demonstrates how to explicitly register specific methods of FCMDeviceAuthorizedViewSet using `as_view` for more granular control over API endpoints in Django REST Framework. This allows defining separate URLs for different actions like device creation.

```python
from fcm_django.api.rest_framework import FCMDeviceAuthorizedViewSet
from django.urls import path

urlpatterns = [
    # Only allow creation of devices by authenticated users
    path('devices', FCMDeviceAuthorizedViewSet.as_view({'post': 'create'}), name='create_fcm_device'),
    # ...
]
```

--------------------------------

### Sending Messages with fcm-django

Source: https://github.com/xtrinch/fcm-django/blob/master/README.rst

Shows how to send messages using the fcm-django library. It covers sending data messages, notification messages, and sending messages to a specific device. The library uses the firebase-admin package for message handling.

```python
from firebase_admin.messaging import Message, Notification
FCMDevice.objects.send_message(Message(data=dict()))
# Note: You can also combine the data and notification kwarg
FCMDevice.objects.send_message(
    Message(notification=Notification(title="title", body="body", image="image_url"))
)
device = FCMDevice.objects.first()
device.send_message(Message(...))
```

--------------------------------

### Handle FCM Topic Subscription

Source: https://github.com/xtrinch/fcm-django/blob/master/docs/index.rst

Subscribes or unsubscribes devices to/from an FCM topic using the handle_topic_subscription method.

```python
from fcm_django.models import FCMDevice

# Subscribing
FCMDevice.objects.all().handle_topic_subscription(True, topic="TOPIC NAME"))
device = FCMDevice.objects.all().first()
device.handle_topic_subscription(True, topic="TOPIC NAME"))

# Unsubscribing
FCMDevice.objects.all().handle_topic_subscription(False, topic="TOPIC NAME"))
device = FCMDevice.objects.all().first()
device.handle_topic_subscription(False, topic="TOPIC NAME"))
```

--------------------------------

### Manually Register FCMDeviceViewSet with DRF URLs in Python

Source: https://github.com/xtrinch/fcm-django/blob/master/docs/index.rst

Demonstrates how to explicitly register the FCMDeviceAuthorizedViewSet using the `as_view` method in Django REST Framework. This approach allows for granular control over which HTTP methods are exposed for specific URL patterns.

```python
from fcm_django.api.rest_framework import FCMDeviceAuthorizedViewSet
from django.urls import path

urlpatterns = [
    # Only allow creation of devices by authenticated users
    path('devices', FCMDeviceAuthorizedViewSet.as_view({'post': 'create'}), name='create_fcm_device'),
    # ...
]
```

--------------------------------

### Sending Messages with fcm-django

Source: https://github.com/xtrinch/fcm-django/blob/master/docs/index.rst

Shows how to send messages using the fcm-django library. It covers sending data messages, notification messages, and sending messages to a specific device. The library uses the firebase-admin package for message handling.

```python
from firebase_admin.messaging import Message, Notification
FCMDevice.objects.send_message(Message(data=dict()))
# Note: You can also combine the data and notification kwarg
FCMDevice.objects.send_message(
    Message(notification=Notification(title="title", body="body", image="image_url"))
)
device = FCMDevice.objects.first()
device.send_message(Message(...))
```

--------------------------------

### Send FCM Messages in Bulk via FCMDevice QuerySet

Source: https://github.com/xtrinch/fcm-django/blob/master/docs/index.rst

Sends FCM messages in bulk to multiple devices using a QuerySet of FCMDevice instances.

```python
from firebase_admin.messaging import Message
from fcm_django.models import FCMDevice

devices = FCMDevice.objects.all()
devices.send_message(Message(data={...}))
```

--------------------------------

### Configure fcm-django Settings

Source: https://github.com/xtrinch/fcm-django/blob/master/docs/index.rst

Details the configuration options for fcm-django in Django's settings.py. This includes setting the default Firebase app, defining an app name, and configuring options like one device per user and automatic deletion of inactive devices.

```python
from firebase_admin import initialize_app

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

# Optional ONLY IF you have initialized a firebase app already:
# Visit https://firebase.google.com/docs/admin/setup/#python
# for more options for the following:
# Store an environment variable called GOOGLE_APPLICATION_CREDENTIALS
# which is a path that point to a json file with your credentials.
# Additional arguments are available: credentials, options, name
FIREBASE_APP = initialize_app()
# To learn more, visit the docs here:
# https://cloud.google.com/docs/authentication/getting-started> 

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/False,
     # devices to which notifications cannot be sent,
     # are deleted upon receiving error response from FCM
     # default: False
    "DELETE_INACTIVE_DEVICES": True/False,
}
```

--------------------------------

### Firebase Topic Messaging with fcm-django

Source: https://github.com/xtrinch/fcm-django/blob/master/README.rst

Illustrates how to use Firebase's Topic API with fcm-django for sending bulk messages. It includes handling subscriptions to topics and sending messages to a specified topic name.

```python
from firebase_admin.messaging import Message, Notification
topic = "A topic"
FCMDevice.objects.handle_subscription(True, topic)
FCMDevice.send_topic_message(Message(data={...}), "TOPIC NAME")
```

--------------------------------

### Firebase Topic Messaging with fcm-django

Source: https://github.com/xtrinch/fcm-django/blob/master/docs/index.rst

Illustrates how to use Firebase's Topic API with fcm-django for sending bulk messages. It includes handling subscriptions to topics and sending messages to a specified topic name.

```python
from firebase_admin.messaging import Message, Notification
topic = "A topic"
FCMDevice.objects.handle_subscription(True, topic)
FCMDevice.send_topic_message(Message(data={...}), "TOPIC NAME")
```

--------------------------------

### Configure fcm-django Settings

Source: https://github.com/xtrinch/fcm-django/blob/master/README.rst

Details the configuration options for fcm-django in Django's settings.py. This includes setting the default Firebase app, defining an app name, and configuring options like one device per user and automatic deletion of inactive devices.

```python
from firebase_admin import initialize_app

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

# Optional ONLY IF you have initialized a firebase app already:
# Visit https://firebase.google.com/docs/admin/setup/#python
# for more options for the following:
# Store an environment variable called GOOGLE_APPLICATION_CREDENTIALS
# which is a path that point to a json file with your credentials.
# Additional arguments are available: credentials, options, name
FIREBASE_APP = initialize_app()
# To learn more, visit the docs here:
# https://cloud.google.com/docs/authentication/getting-started> 

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/False,
     # devices to which notifications cannot be sent,
     # are deleted upon receiving error response from FCM
     # default: False
    "DELETE_INACTIVE_DEVICES": True/False,
}
```

--------------------------------

### DRF: Register FCMDeviceViewSet with DefaultRouter

Source: https://github.com/xtrinch/fcm-django/blob/master/README.rst

Shows how to integrate FCMDeviceViewSet with Django REST Framework's DefaultRouter to automatically generate API endpoints for device management. Requires DRF and fcm-django.

```python
from fcm_django.api.rest_framework import FCMDeviceAuthorizedViewSet
from django.urls import path, include
from rest_framework.routers import DefaultRouter

router = DefaultRouter()

router.register('devices', FCMDeviceAuthorizedViewSet)

urlpatterns = [
    # URLs will show up at <api_root>/devices
    # DRF browsable API which lists all available endpoints
    path('', include(router.urls)),
    # ...
]
```

--------------------------------

### Send FCM Notification Message

Source: https://github.com/xtrinch/fcm-django/blob/master/README.rst

Demonstrates sending a Firebase Cloud Messaging notification message with a title, body, image, and an optional topic.

```python
from firebase_admin.messaging import Message, Notification
Message(
    notification=Notification(title="title", body="text", image="url"),
    topic="Optional topic parameter: Whatever you want",
)
```

--------------------------------

### Send FCM Messages in Bulk via FCMDevice Manager

Source: https://github.com/xtrinch/fcm-django/blob/master/docs/index.rst

Sends FCM messages in bulk to multiple devices using the FCMDevice manager.

```python
from firebase_admin.messaging import Message
from fcm_django.models import FCMDevice

FCMDevice.objects.send_message(Message(data={...}))
```

--------------------------------

### Send FCM Message with Additional Parameters

Source: https://github.com/xtrinch/fcm-django/blob/master/README.rst

Illustrates sending an FCM message with additional parameters like `additional_registration_ids` and `skip_registration_id_lookup`.

```python
from firebase_admin.messaging import Message
from fcm_django.models import FCMDevice
FCMDevice.objects.send_message(Message(...), False, ["registration_ids"])
```

--------------------------------

### Send FCM Data Message

Source: https://github.com/xtrinch/fcm-django/blob/master/README.rst

Illustrates sending a Firebase Cloud Messaging data message containing key-value pairs and an optional topic.

```python
from firebase_admin.messaging import Message
Message(
    data={
        "Nick" : "Mario",
        "body" : "great match!",
        "Room" : "PortugalVSDenmark"
   },
   topic="Optional topic parameter: Whatever you want",
)
```

--------------------------------

### Define Custom FCMDevice Model in Django

Source: https://github.com/xtrinch/fcm-django/blob/master/README.rst

Illustrates how to create a custom FCMDevice model by inheriting from `AbstractFCMDevice`. This allows for adding custom fields or modifying existing ones to suit specific application needs. The custom model must be specified in `settings.py`.

```python
import uuid
from django.db import models
from fcm_django.models import AbstractFCMDevice


class CustomDevice(AbstractFCMDevice):
    # fields could be overwritten
    id = models.UUIDField(primary_key=True, default=uuid.uuid4, editable=False)
    # could be added new fields
    updated_at = models.DateTimeField(auto_now=True)
```

--------------------------------

### Register CustomDevice with DeviceAdmin in Django

Source: https://github.com/xtrinch/fcm-django/blob/master/README.rst

This snippet shows how to unregister the default CustomDevice and register it with fcm_django's DeviceAdmin in your Django app's admin.py file. This is necessary after removing 'fcm_django' from INSTALLED_APPS to ensure devices are visible in the admin panel.

```python
from django.contrib import admin

from fcm_django.admin import DeviceAdmin
from your_app.models import CustomDevice


admin.site.unregister(CustomDevice)
admin.site.register(CustomDevice, DeviceAdmin)
```

--------------------------------

### Register Custom Device Admin

Source: https://github.com/xtrinch/fcm-django/blob/master/docs/index.rst

This snippet shows how to unregister the default CustomDevice and register it with the DeviceAdmin from fcm_django. This is necessary after removing 'fcm_django' from INSTALLED_APPS to ensure devices are visible in the admin panel.

```python
from django.contrib import admin

from fcm_django.admin import DeviceAdmin
from your_app.models import CustomDevice


admin.site.unregister(CustomDevice)
admin.site.register(CustomDevice, DeviceAdmin)
```

--------------------------------

### Send FCM Notification Message

Source: https://github.com/xtrinch/fcm-django/blob/master/docs/index.rst

Constructs and sends an FCM notification message with a title, body, image, and topic.

```python
from firebase_admin.messaging import Message, Notification
Message(
    notification=Notification(title="title", body="text", image="url"),
    topic="Optional topic parameter: Whatever you want",
)
```

--------------------------------

### Send FCM Message to a Topic

Source: https://github.com/xtrinch/fcm-django/blob/master/README.rst

Shows the method for sending an FCM message directly to a specified topic using `send_topic_message`.

```python
from fcm_django.models import FCMDevice

FCMDevice.send_topic_message(Message(data={...}), "TOPIC NAME")
```

--------------------------------

### Send FCM Message Using a Specific FCM App

Source: https://github.com/xtrinch/fcm-django/blob/master/README.rst

Demonstrates how to send an FCM message using a specific Firebase App instance, overriding the default app configuration.

```python
from firebase_app import App
from firebase_app.messaging import Notification
from fcm_django.models import FCMDevice

device = FCMDevice.objects.all().first()
device.send_message(notification=Notification(...), app=App(...))
```

--------------------------------

### Send FCM Message via FCMDevice

Source: https://github.com/xtrinch/fcm-django/blob/master/docs/index.rst

Sends an FCM message using an FCMDevice instance, allowing for message customization and targeting specific devices.

```python
from firebase_admin.messaging import Message
from fcm_django.models import FCMDevice

device = FCMDevice.objects.all().first()
device.send_message(Message(data={...}))
```

--------------------------------

### Register FCMDeviceViewSet with DRF Routers in Python

Source: https://github.com/xtrinch/fcm-django/blob/master/docs/index.rst

Shows how to register the FCMDeviceAuthorizedViewSet with Django REST Framework's DefaultRouter. This allows all views provided by the ViewSet to be automatically included in the API routes.

```python
from fcm_django.api.rest_framework import FCMDeviceAuthorizedViewSet

from rest_framework.routers import DefaultRouter
from django.urls import path, include

router = DefaultRouter()

router.register('devices', FCMDeviceAuthorizedViewSet)

urlpatterns = [
    # URLs will show up at <api_root>/devices
    # DRF browsable API which lists all available endpoints
    path('', include(router.urls)),
    # ...
]
```

--------------------------------

### Define a Custom FCMDevice Model in Python

Source: https://github.com/xtrinch/fcm-django/blob/master/docs/index.rst

Illustrates how to create a custom FCMDevice model by inheriting from `AbstractFCMDevice`. This allows for adding custom fields or modifying existing ones, such as adding a UUID primary key and an `updated_at` timestamp.

```python
import uuid
from django.db import models
from fcm_django.models import AbstractFCMDevice


class CustomDevice(AbstractFCMDevice):
    # fields could be overwritten
    id = models.UUIDField(primary_key=True, default=uuid.uuid4, editable=False)
    # could be added new fields
    updated_at = models.DateTimeField(auto_now=True)
```

--------------------------------

### Configure Custom FCMDevice Model in Django Settings

Source: https://github.com/xtrinch/fcm-django/blob/master/README.rst

Explains how to configure Django to use a custom FCMDevice model by setting the `FCM_DJANGO_FCMDEVICE_MODEL` variable in `settings.py`. This ensures that fcm-django utilizes the user-defined model for device storage.

```python
FCM_DJANGO_FCMDEVICE_MODEL = "your_app.CustomDevice"
```

--------------------------------

### Send FCM Message with Additional Parameters

Source: https://github.com/xtrinch/fcm-django/blob/master/docs/index.rst

Sends an FCM message with additional registration IDs and an option to skip database lookup.

```python
from firebase_admin.messaging import Message
from fcm_django.models import FCMDevice
FCMDevice.objects.send_message(Message(...), False, ["registration_ids"])
```

--------------------------------

### Send FCM Message to a Single Device

Source: https://github.com/xtrinch/fcm-django/blob/master/README.rst

Shows how to send an FCM message to a specific device retrieved from the FCMDevice model. It utilizes the `send_message` method of the FCMDevice instance.

```python
from firebase_admin.messaging import Message
from fcm_django.models import FCMDevice

device = FCMDevice.objects.all().first()
device.send_message(Message(data={...}))
```

--------------------------------

### Send FCM Message using a Specific FCM App

Source: https://github.com/xtrinch/fcm-django/blob/master/docs/index.rst

Sends an FCM message using a specific FCM app instance, allowing for multi-project configurations.

```python
from firebase_app import App
from firebase_app.messaging import Notification
from fcm_django.models import FCMDevice

device = FCMDevice.objects.all().first()
device.send_message(notification=Notification(...), app=App(...))
```

--------------------------------

### Send FCM Message to Topic

Source: https://github.com/xtrinch/fcm-django/blob/master/docs/index.rst

Sends an FCM message directly to a specified topic.

```python
from fcm_django.models import FCMDevice
from firebase_admin.messaging import Message

FCMDevice.send_topic_message(Message(data={...}), "TOPIC NAME")
```

--------------------------------

### MySQL Compatibility Settings

Source: https://github.com/xtrinch/fcm-django/blob/master/docs/index.rst

Configuration for fcm-django to handle MySQL compatibility issues, specifically the limit on indices. Setting FCM_DJANGO_SETTINGS['MYSQL_COMPATIBILITY'] to True removes the unique constraint on the registration_id field for MySQL.

```python
FCM_DJANGO_SETTINGS = {
    "MYSQL_COMPATIBILITY": True,
    # [...] your other settings
}
```

--------------------------------

### Configure Custom FCMDevice Model in Django Settings

Source: https://github.com/xtrinch/fcm-django/blob/master/docs/index.rst

Explains how to configure Django to use a custom FCMDevice model by setting the `FCM_DJANGO_FCMDEVICE_MODEL` variable in `settings.py`. This tells the fcm-django package to use the specified model instead of the default one.

```python
FCM_DJANGO_FCMDEVICE_MODEL = "your_app.CustomDevice"
```

--------------------------------

### Exclude Default FCMDevice Table

Source: https://github.com/xtrinch/fcm-django/blob/master/README.rst

Provides instructions on how to prevent the default FCMDevice table from being created in the database when using a custom FCMDevice model. This is achieved by removing 'fcm_django' from `INSTALLED_APPS` in `settings.py`.

```python
INSTALLED_APPS = (
    ...
)
```

--------------------------------

### Send FCM Data Message

Source: https://github.com/xtrinch/fcm-django/blob/master/docs/index.rst

Constructs and sends an FCM data message with custom key-value pairs and a topic.

```python
from firebase_admin.messaging import Message
Message(
    data={
        "Nick" : "Mario",
        "body" : "great match!",
        "Room" : "PortugalVSDenmark"
   },
   topic="Optional topic parameter: Whatever you want",
)
```

--------------------------------

### Remove Default FCM Table from Django Apps

Source: https://github.com/xtrinch/fcm-django/blob/master/docs/index.rst

Provides instructions on how to prevent the default FCMDevice table from being created in the database. This is achieved by removing 'fcm_django' from the `INSTALLED_APPS` setting in `settings.py` when using a custom model.

```python
INSTALLED_APPS = (
    ...
    # Remove 'fcm_django' if you only want your custom model's table
)
```
Tokens:
Raw