com.flowable.engage.api.notification.push

Interface DeviceRegistration

All Known Implementing Classes:

DeviceRegistrationImpl

public interface DeviceRegistration

Author:

Filip Hrisafov

Method Summary

Modifier and Type	Method and Description
DeviceRegistration	applicationId(String applicationId) The id of the application that this device is registered for.
DeviceRegistration	deviceOS(String deviceOS) The OS of the device.
DeviceRegistration	disabled() Register a disabled device.
Device	register() Perform the registration of the device.
DeviceRegistration	tenantId(String tenantId) The id of the tenant in which this device is registered in.
DeviceRegistration	token(String token) The token for the new device.
DeviceRegistration	tokenEncoding(String tokenEncoding) The encoding of the token.
DeviceRegistration	userId(String userId) The id of the user that this device is registered to.

Method Detail

token

DeviceRegistration token(String token)

The token for the new device. This is a mandatory field.

Parameters:

token - the token

tokenEncoding

DeviceRegistration tokenEncoding(String tokenEncoding)

The encoding of the token. By default it is none.

Parameters:

tokenEncoding - the encoding of the token

See Also:

DeviceTokenEncodings

disabled

DeviceRegistration disabled()

Register a disabled device. By default an enabled device is registered.

deviceOS

DeviceRegistration deviceOS(String deviceOS)

The OS of the device. This is a mandatory field.

Parameters:

deviceOS - the OS device

See Also:

DeviceOS

userId

DeviceRegistration userId(String userId)

The id of the user that this device is registered to.

Parameters:

userId - the id of the user

applicationId

DeviceRegistration applicationId(String applicationId)

The id of the application that this device is registered for.

Parameters:

applicationId - the id of the application

tenantId

DeviceRegistration tenantId(String tenantId)

The id of the tenant in which this device is registered in.

Parameters:

tenantId - the tenant id

register

Device register()

Perform the registration of the device. Make sure that the mandatory fields token(String) and deviceOS(String) have been set.

Returns:

the newly registered device