Register a Device

Registering a Device

Overview

The registerDevice method in the b.well SDK allows for the registration of a device using a specific device token. This process is essential for enabling push notification functionality.

Method Signature

suspend fun registerDevice(deviceRequest: RegisterDeviceTokenRequest): OperationOutcome
  • deviceRequest: Contains the device token, platform, and application name for the device registration.
  • OperationOutcome: Represents the outcome of the device registration process.

Example Usage

To register a device, you first create a RegisterDeviceTokenRequest with the necessary details:

val registerDeviceTokenRequest: RegisterDeviceTokenRequest = RegisterDeviceTokenRequest.Builder()  
    .deviceToken(deviceId)  
    .applicationName("AppName")  
    .platform(DevicePlatform.ANDROID)  
    .build()  
registerDeviceToken(registerDeviceTokenRequest)  

Then, you can implement the registerDeviceToken function to handle the registration process:

suspend fun registerDeviceToken(registerDeviceTokenRequest: RegisterDeviceTokenRequest): Flow<OperationOutcome?> = flow {
        try {
            val outcome: OperationOutcome? = BWellSdk.device?.registerDevice(registerDeviceTokenRequest)
            emit(outcome)
        } catch (e: Exception) {
            // Handle exceptions
        }
    }

This code demonstrates how to build a request for device registration and handle the response using Kotlin coroutines.

Best Practices

  • Valid Device Token: Ensure that the device token provided is valid and corresponds to the device being registered.
  • Outcome Handling: Handle both successful and unsuccessful registration outcomes to ensure robust app behavior.