org.cyclos.services.users

Interface FcmTokenService

All Superinterfaces:

Service

All Known Subinterfaces:

FcmTokenServiceLocal

All Known Implementing Classes:

FcmTokenServiceSecurity

public interface FcmTokenService
extends Service

Service implementing the Firebase Cloud Messaging registration tokens of a user

Author:

ameyer

Method Summary

Modifier and Type	Method and Description
void	assign(@NotNull java.lang.String token) Assigns the given registration token to the logged user.
void	remove(@NotNull java.lang.String token, @NotNull java.util.Set<java.lang.Long> users) Removed a token from the given users.
void	replace(@NotNull java.lang.String oldToken, @NotNull java.lang.String newToken) Replace a token with it's new value.

Method Detail

assign

void assign(@NotNull
            @NotNull java.lang.String token)
     throws FrameworkException

Assigns the given registration token to the logged user.

Parameters:

token - the FCM registration token

Throws:

FrameworkException

remove

void remove(@NotNull
            @NotNull java.lang.String token,
            @NotNull
            @NotNull java.util.Set<java.lang.Long> users)
     throws FrameworkException

Removed a token from the given users. Can be invoked as guest.

Parameters:

token - the FCM registration token to be removed

users - the set of users from whom the token will be removed

Throws:

FrameworkException

replace

void replace(@NotNull
             @NotNull java.lang.String oldToken,
             @NotNull
             @NotNull java.lang.String newToken)
      throws FrameworkException

Replace a token with it's new value. Can be invoked as guest.

Parameters:

oldToken - the existing token

newToken - the new token value

Throws:

FrameworkException