Package dev.getelements.elements.sdk.service.firebase

Interface FCMRegistrationService

All Known Implementing Classes:
SuperUserFCMRegistrationService, UserFCMRegistrationService
public interface FCMRegistrationService
Manages instance of FCMRegistration. This provides methods to create, update, and delete registrations with the Firebase Notification Service.

  • Method Details

    • createRegistration

      FCMRegistration createRegistration(FCMRegistration fcmRegistration)
      Creates a new instance of FCMRegistration. In addition to ensuring the token has been written to the database, this may perform any other actions necessary such as subscribing the token to a specific topic.
      Parameters:
      fcmRegistration - the instance of FCMRegistration
      Returns:
      the FCMRegistration instance as it was written to the database

    • updateRegistration

      FCMRegistration updateRegistration(FCMRegistration fcmRegistration)
      Updates an existing instance of FCMRegistration. In addition to ensuring the token has been written to the database, this may perform any other actions necessary such as subscribing the token to a specific topic or refreshing an existing registration.
      Parameters:
      fcmRegistration - the instance of FCMRegistration
      Returns:
      the FCMRegistration instance as it was written to the database

    • deleteRegistration

      void deleteRegistration(String fcmRegistrationId)
      Delets an instance of FCMRegistration based on the supplied ID. The ID can be obtained by FCMRegistration.getId(). In addition to removing the registration, this may also perform other actions such as unsubscribing from necessary topics.
      Parameters:
      fcmRegistrationId - as determined by FCMRegistration.getId()