PushNotificationInterface

Hierarchy

PushNotificationInterface

Implemented by

Index

Properties

addPluggable

addPluggable: function

Type declaration

- (pluggable: PushNotificationProvider): void
- Parameters
  - pluggable: PushNotificationProvider
  Returns void

configure

configure: function

Type declaration

- (config: PushNotificationConfig): PushNotificationConfig
- Parameters
  - config: PushNotificationConfig
  Returns PushNotificationConfig

enable

enable: function

Type declaration

- (): void
- Returns void

getBadgeCount

getBadgeCount: function

Type declaration

- (): Promise<number>
- Returns Promise<number>

getLaunchNotification

getLaunchNotification: function

Type declaration

- (): Promise<PushNotificationMessage>
- Returns Promise<PushNotificationMessage>

getModuleName

getModuleName: function

Type declaration

- (): NotificationsSubCategory
- Returns NotificationsSubCategory

getPermissionStatus

getPermissionStatus: function

Type declaration

- (): Promise<PushNotificationPermissionStatus>
- Returns Promise<PushNotificationPermissionStatus>

getPluggable

getPluggable: function

Type declaration

- (providerName: string): PushNotificationProvider
- Parameters
  - providerName: string
  Returns PushNotificationProvider

identifyUser

identifyUser: function

Type declaration

- (userId: string, userInfo: UserInfo): Promise<void[]>
- Parameters
  - userId: string
  - userInfo: UserInfo
  Returns Promise<void[]>

onNotificationOpened

onNotificationOpened: function

Type declaration

- (handler: OnPushNotificationMessageHandler): EventListener<OnPushNotificationMessageHandler>
- Parameters
  - handler: OnPushNotificationMessageHandler
  Returns EventListener<OnPushNotificationMessageHandler>

onNotificationReceivedInBackground

onNotificationReceivedInBackground: function

Type declaration

- (handler: OnPushNotificationMessageHandler): EventListener<OnPushNotificationMessageHandler>
- Parameters
  - handler: OnPushNotificationMessageHandler
  Returns EventListener<OnPushNotificationMessageHandler>

onNotificationReceivedInForeground

onNotificationReceivedInForeground: function

Type declaration

- (handler: OnPushNotificationMessageHandler): EventListener<OnPushNotificationMessageHandler>
- Parameters
  - handler: OnPushNotificationMessageHandler
  Returns EventListener<OnPushNotificationMessageHandler>

onTokenReceived

onTokenReceived: function

Type declaration

- (handler: OnTokenReceivedHandler): EventListener<OnTokenReceivedHandler>
- Parameters
  - handler: OnTokenReceivedHandler
  Returns EventListener<OnTokenReceivedHandler>

removePluggable

removePluggable: function

Type declaration

- (providerName: string): void
- Parameters
  - providerName: string
  Returns void

requestPermissions

requestPermissions: function

Type declaration

- (permissions?: PushNotificationPermissions): Promise<boolean>
- Parameters
  - Optional permissions: PushNotificationPermissions
  Returns Promise<boolean>

setBadgeCount

setBadgeCount: function

Type declaration

- (count: number): void
- Parameters
  - count: number
  Returns void

Hierarchy

Implemented by

Index

Properties

Properties

addPluggable

Type declaration

Parameters

pluggable: PushNotificationProvider

Returns void

configure

Type declaration

Parameters

config: PushNotificationConfig

Returns PushNotificationConfig

enable

Type declaration

Returns void

getBadgeCount

Type declaration

Returns Promise<number>

getLaunchNotification

Type declaration

Returns Promise<PushNotificationMessage>

getModuleName

Type declaration

Returns NotificationsSubCategory

getPermissionStatus

Type declaration

Returns Promise<PushNotificationPermissionStatus>

getPluggable

Type declaration

Parameters

providerName: string

Returns PushNotificationProvider

identifyUser

Type declaration

Parameters

userId: string

userInfo: UserInfo

Returns Promise<void[]>

onNotificationOpened

Type declaration

Parameters

handler: OnPushNotificationMessageHandler

Returns EventListener<OnPushNotificationMessageHandler>

onNotificationReceivedInBackground

Type declaration

Parameters

handler: OnPushNotificationMessageHandler

Returns EventListener<OnPushNotificationMessageHandler>

onNotificationReceivedInForeground

Type declaration

Parameters

handler: OnPushNotificationMessageHandler

Returns EventListener<OnPushNotificationMessageHandler>

onTokenReceived

Type declaration

Parameters

handler: OnTokenReceivedHandler

Returns EventListener<OnTokenReceivedHandler>

removePluggable

Type declaration

Parameters

providerName: string

Returns void

requestPermissions

Type declaration

Parameters

Optional permissions: PushNotificationPermissions

Returns Promise<boolean>

setBadgeCount

Type declaration

Parameters

count: number

Returns void