API reference
API reference
Select your platform
No SDKs available
No versions available

DeviceNotificationConfig Interface

The Notification Params, to be passed in to Notifications.deviceNotification, is a field that allows developers to specify a list of parameters to config the on device notification.

Signature

interface DeviceNotificationConfig

Properties

actionDisplayType : String?
[Get]
The notification action display type, which determines whether actions are displayed as 'ICONABLE', 'ICONABLE_COLORLESS', or 'TEXT_ONLY'. (see https://fburl.com/code/nfqxeecd)
Signature
abstract val actionDisplayType: String?
actions : String?
[Get]
The notification action, which will be used to open the app or perform another action when the action button is clicked.
Signature
abstract val actions: String?
appPackageNameForAppIcon : String?
[Get]
This variable holds the app package name associated with the app icon shown in the notification body. It is only required when your app displays a notification with a different app icon.
Signature
abstract val appPackageNameForAppIcon: String?
isToastOnly : Boolean?
[Get]
Indicates whether the notification should only be displayed as a toast. If true, the notification will not appear in notification feed.
Signature
abstract val isToastOnly: Boolean?
mediaAttachmentUri : String?
[Get]
The attached image uri for the notification.
Signature
abstract val mediaAttachmentUri: String?
message : String
[Get]
The message body for the notification.
Signature
abstract val message: String
ndid : String?
[Get]
The notification delivery id used to track this notification. Make sure you never pass in same ndid for different notification instance, otherwise the notification won't be present.
Signature
abstract val ndid: String?
title : String
[Get]
The title for the notification.
Signature
abstract val title: String

Companion Object

Companion Object Functions

builder ()
Signature
fun builder(): DeviceNotificationConfig.Builder
Returns
DeviceNotificationConfig.Builder

Inner Interface

Builder Interface

Signature

interface Builder

Functions

build ()
Signature
abstract fun build(): DeviceNotificationConfig
Returns
DeviceNotificationConfig
withActionDisplayType ( actionDisplayType )
Signature
abstract fun withActionDisplayType(actionDisplayType: String?): DeviceNotificationConfig.Builder
Parameters
actionDisplayType: String?
Returns
DeviceNotificationConfig.Builder
withActions ( actions )
Signature
abstract fun withActions(actions: String?): DeviceNotificationConfig.Builder
Parameters
actions: String?
Returns
DeviceNotificationConfig.Builder
withAppPackageNameForAppIcon ( appPackageNameForAppIcon )
Signature
abstract fun withAppPackageNameForAppIcon(appPackageNameForAppIcon: String?): DeviceNotificationConfig.Builder
Parameters
appPackageNameForAppIcon: String?
Returns
DeviceNotificationConfig.Builder
withIsToastOnly ( isToastOnly )
Signature
abstract fun withIsToastOnly(isToastOnly: Boolean?): DeviceNotificationConfig.Builder
Parameters
isToastOnly: Boolean?
Returns
DeviceNotificationConfig.Builder
withMediaAttachmentUri ( mediaAttachmentUri )
Signature
abstract fun withMediaAttachmentUri(mediaAttachmentUri: String?): DeviceNotificationConfig.Builder
Parameters
mediaAttachmentUri: String?
Returns
DeviceNotificationConfig.Builder
withMessage ( message )
Signature
abstract fun withMessage(message: String): DeviceNotificationConfig.Builder
Parameters
message: String
Returns
DeviceNotificationConfig.Builder
withNdid ( ndid )
Signature
abstract fun withNdid(ndid: String?): DeviceNotificationConfig.Builder
Parameters
ndid: String?
Returns
DeviceNotificationConfig.Builder
withTitle ( title )
Signature
abstract fun withTitle(title: String): DeviceNotificationConfig.Builder
Parameters
title: String
Returns
DeviceNotificationConfig.Builder
Did you find this page helpful?