FcmTokenService (Cyclos 4.16.19 Scripting API Documentation)

All Superinterfaces:

Service

All Known Subinterfaces:

FcmTokenServiceLocal
```
public interface FcmTokenService
extends Service
```
Service implementing the Firebase Cloud Messaging registration tokens of a user

Method Summary

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

- Method Detail
  - assign
```
void assign(@NotNull
            @NotNull String token)
     throws FrameworkException
```
    Assigns the given registration token to the logged user. If the token was already assigned then the used date is updated
    
    Parameters:
    
    token - the FCM registration token
    
    Throws:
    
    FrameworkException
  - remove
```
void remove(@NotNull
            @NotNull String token,
            @NotNull
            @NotNull Set<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 String oldToken,
             @NotNull
             @NotNull 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