Interface DeviceRegistration
- All Known Implementing Classes:
DeviceRegistrationImpl
public interface DeviceRegistration
- Author:
- Filip Hrisafov
-
Method Summary
Modifier and TypeMethodDescriptionapplicationId
(String applicationId) The id of the application that this device is registered for.The OS of the device.disabled()
Register a disabled device.register()
Perform the registration of the device.The id of the tenant in which this device is registered in.The token for the new device.tokenEncoding
(String tokenEncoding) The encoding of the token.The id of the user that this device is registered to.
-
Method Details
-
token
The token for the new device. This is a mandatory field.- Parameters:
token
- the token
-
tokenEncoding
The encoding of the token. By default it isnone
.- Parameters:
tokenEncoding
- the encoding of the token- See Also:
-
disabled
DeviceRegistration disabled()Register a disabled device. By default an enabled device is registered. -
deviceOS
The OS of the device. This is a mandatory field.- Parameters:
deviceOS
- the OS device- See Also:
-
userId
The id of the user that this device is registered to.- Parameters:
userId
- the id of the user
-
applicationId
The id of the application that this device is registered for.- Parameters:
applicationId
- the id of the application
-
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 fieldstoken(String)
anddeviceOS(String)
have been set.- Returns:
- the newly registered device
-