Package dev.getelements.elements.sdk.dao

Interface FCMRegistrationDao

All Known Implementing Classes:

MongoFCMRegistrationDao

public interface FCMRegistrationDao

Manipulates instances of FCMRegistration in the underlying database.

Method Summary

Modifier and Type	Method	Description
FCMRegistration	createRegistration(FCMRegistration fcmRegistration)	Creates an instance of FCMRegistration and stores it in the database.
void	deleteRegistration(String fcmRegistrationId)	Deletes an instance of FCMRegistration based on the supplied id.
void	deleteRegistrationWithRequestingProfile(Profile profile, String fcmRegistrationId)	Deletes an instance of FCMRegistration based on the supplied id.
default Stream<FCMRegistration>	getDistinctRegistrationsForRecipient(String recipientId)	Ensures that the Stream returned will only contain each FCMRegistration once, and only once.
Stream<FCMRegistration>	getRegistrationsForRecipient(String recipientId)	Gets a Stream<FCMRegistration> containing all currently registered FCMRegistration instances associated witht he supplied Profile id of the recipient.
FCMRegistration	updateRegistration(FCMRegistration fcmRegistration)	Updates an instance of FCMRegistration in the database.

Method Details

createRegistration

FCMRegistration createRegistration(FCMRegistration fcmRegistration)

Creates an instance of FCMRegistration and stores it in the database.

Parameters:

fcmRegistration - the FCMRegistration

Returns:

the FCMRegistration instance as it was created in the database

updateRegistration

FCMRegistration updateRegistration(FCMRegistration fcmRegistration)

Updates an instance of FCMRegistration in the database. Reassigning the values of FCMRegistration.getProfile() or FCMRegistration.getRegistrationToken() as necessary

Parameters:

fcmRegistration - the FCMRegistration instance

Returns:

the FCMRegistration isntance as it was written to the database

deleteRegistration

void deleteRegistration(String fcmRegistrationId)

Deletes an instance of FCMRegistration based on the supplied id. The id value corresponds to the value returned by FCMRegistration.getId().

Parameters:

fcmRegistrationId - the id of the FCMRegistration as supplied by FCMRegistration.getId()

deleteRegistrationWithRequestingProfile

void deleteRegistrationWithRequestingProfile(Profile profile,
 String fcmRegistrationId)

Deletes an instance of FCMRegistration based on the supplied id. The id value corresponds to the value returned by FCMRegistration.getId(). Additionally, this must refuse the if the supplied Profile does not match the owner of the correspendong FCMRegistration.

Parameters:

fcmRegistrationId - the id of the FCMRegistration as supplied by FCMRegistration.getId()

getRegistrationsForRecipient

Stream<FCMRegistration> getRegistrationsForRecipient(String recipientId)

Gets a Stream<FCMRegistration> containing all currently registered FCMRegistration instances associated witht he supplied Profile id of the recipient.

Parameters:

recipientId - the Profile id of the recipient, as returned by Profile.getId()

Returns:

a Stream<FCMRegistration> containing all matching FCMRegistration instances

getDistinctRegistrationsForRecipient

default Stream<FCMRegistration> getDistinctRegistrationsForRecipient(String recipientId)

Ensures that the Stream returned will only contain each FCMRegistration once, and only once. The default implementation of this method uses a technique similar to Stream.distinct(), but implementations may opt to use the underlying database to optimize this operation.

Parameters:

recipientId - the Profile id of the recipient, as returned by Profile.getId()

Returns:

a Stream<FCMRegistration> containing all matching FCMRegistration instances