Device Registration

Device registration connects the current signed-in user to the device token that the operating system gives your app. Use it after your app has completed the platform push-notification setup and after the SDK client is initialized for a signed-in user.

The TypeScript SDK does not expose a client-side device registration API. Use the native iOS, Android, or Flutter SDK APIs on device, and use server-side/webhook flows for web delivery.

Platform Surface

Platform	Register	Unregister	Token argument
iOS	`client.registerPushNotification(withDeviceToken:)`	`client.unregisterPushNotification()`	`token: String`
Android	`AmityCoreClient.registerPushNotification()`	`AmityCoreClient.unregisterPushNotification()`	None
Flutter	`AmityCoreClient.registerDeviceNotification(fcmToken)`	`AmityCoreClient.unregisterDeviceNotification()`	`fcmToken: String`
TypeScript	Not available	Not available	Not available

Parameters

Name	Platform	Type	Required	Description
`token`	iOS	`String`	Yes	APNs device token passed to `registerPushNotification(withDeviceToken:)`.
`fcmToken`	Flutter	`String`	Yes	FCM token passed to `registerDeviceNotification`.

Android registration does not accept a token argument in the current SDK API. The Android SDK registers the current signed-in user/device through AmityCoreClient.registerPushNotification().

Register A Device

try await client.registerPushNotification(withDeviceToken: "<device-token>")

AmityCoreClient.registerPushNotification()
    .doOnComplete {
        // Device registration completed.
    }
    .doOnError { error ->
        // Handle registration error.
    }
    .subscribe()

await AmityCoreClient.registerDeviceNotification(fcmToken);

On Android, registerPushNotification() is a no-op for visitor and bot users. Register only after the app has a signed-in user session.

Unregister A Device

Call unregister when the user signs out or when this app installation should stop receiving push notifications for the currently registered user.

try await client.unregisterPushNotification()

AmityCoreClient.unregisterPushNotification()
    .doOnComplete {
        // Device unregistration completed.
    }
    .doOnError { error ->
        // Handle unregistration error.
    }
    .subscribe()

await AmityCoreClient.unregisterDeviceNotification();

Complete platform setup before calling the SDK registration API:

Powered by

Getting Started

Fundamentals

Social

Chat

Video

Release Notes

Migration Guides

Support

Platform Surface

Parameters

Register A Device

Unregister A Device

​Platform Surface

​Parameters

​Register A Device

​Unregister A Device

​Related Setup

Platform Surface

Parameters

Register A Device

Unregister A Device

Related Setup