PushNotification | amplify-js

deprecated

This package (@aws-amplify/pushnotification) is on a deprecation path. Please see the following link for instructions on how to migrate to a new version of Amplify Push Notifications.

https://docs.amplify.aws/lib/push-notifications/migrate-from-previous-version/q/platform/react-native/

Hierarchy

PushNotification

Implements

Index

Constructors

constructor

Constructors

constructor

new PushNotification(): PushNotification

- Defined in packages/notifications/src/PushNotification/PushNotification.native.ts:49
deprecated

This package (@aws-amplify/pushnotification) is on a deprecation path. Please see the following link for instructions on how to migrate to a new version of Amplify Push Notifications.

https://docs.amplify.aws/lib/push-notifications/migrate-from-previous-version/q/platform/react-native/

deprecated

This package (@aws-amplify/pushnotification) is on a deprecation path. Please see the following link for instructions on how to migrate to a new version of Amplify Push Notifications.

https://docs.amplify.aws/lib/push-notifications/migrate-from-previous-version/q/platform/react-native/

Returns PushNotification

Methods

_checkIfOpenedByNotification

_checkIfOpenedByNotification(nextAppState: any, handler: any): void

- Defined in packages/pushnotification/src/PushNotification.ts:247
This function handles the React Native AppState change event And checks if the app was launched by a Push Notification Note: Current AppState will be null or 'unknown' if the app is coming from killed state to active

deprecated

This package (@aws-amplify/pushnotification) is on a deprecation path. Please see the following link for instructions on how to migrate to a new version of Amplify Push Notifications.

https://docs.amplify.aws/lib/push-notifications/migrate-from-previous-version/q/platform/react-native/

Parameters
- nextAppState: any
  
  The next state the app is changing to as part of the event
- handler: any
Returns void

_registerTokenCached

_registerTokenCached(): Promise<boolean>

- Defined in packages/pushnotification/src/PushNotification.ts:197
deprecated

This package (@aws-amplify/pushnotification) is on a deprecation path. Please see the following link for instructions on how to migrate to a new version of Amplify Push Notifications.

https://docs.amplify.aws/lib/push-notifications/migrate-from-previous-version/q/platform/react-native/

Returns Promise<boolean>

addEventListenerForAndroid

addEventListenerForAndroid(event: any, handler: any): void

- Defined in packages/pushnotification/src/PushNotification.ts:450
deprecated

This package (@aws-amplify/pushnotification) is on a deprecation path. Please see the following link for instructions on how to migrate to a new version of Amplify Push Notifications.

https://docs.amplify.aws/lib/push-notifications/migrate-from-previous-version/q/platform/react-native/

Parameters
- event: any
- handler: any
Returns void

addEventListenerForIOS

addEventListenerForIOS(event: any, handler: any): void

- Defined in packages/pushnotification/src/PushNotification.ts:476
deprecated

This package (@aws-amplify/pushnotification) is on a deprecation path. Please see the following link for instructions on how to migrate to a new version of Amplify Push Notifications.

https://docs.amplify.aws/lib/push-notifications/migrate-from-previous-version/q/platform/react-native/

Parameters
- event: any
- handler: any
Returns void

addPluggable

addPluggable(_: PushNotificationProvider): void
addPluggable(pluggable: PushNotificationProvider): void

- Defined in packages/notifications/src/PushNotification/PushNotification.ts:46
Add plugin into PushNotification Add plugin into PushNotification

Parameters
- _: PushNotificationProvider
Returns void
- Defined in packages/notifications/src/PushNotification/PushNotification.native.ts:121
Add plugin into PushNotification Add plugin into PushNotification

Parameters
- pluggable: PushNotificationProvider
Returns void

configure

configure(_?: PushNotificationConfig): PushNotificationConfig
configure(config?: PushNotificationConfig): PushNotificationConfig

- Defined in packages/notifications/src/PushNotification/PushNotification.ts:22
Configure PushNotification Configure PushNotification

deprecated

This package (@aws-amplify/pushnotification) is on a deprecation path. Please see the following link for instructions on how to migrate to a new version of Amplify Push Notifications.

https://docs.amplify.aws/lib/push-notifications/migrate-from-previous-version/q/platform/react-native/

deprecated

This package (@aws-amplify/pushnotification) is on a deprecation path. Please see the following link for instructions on how to migrate to a new version of Amplify Push Notifications.

https://docs.amplify.aws/lib/push-notifications/migrate-from-previous-version/q/platform/react-native/

Parameters
- Default value _: PushNotificationConfig = {}
Returns PushNotificationConfig
- Defined in packages/notifications/src/PushNotification/PushNotification.native.ts:76
Configure PushNotification Configure PushNotification

deprecated

This package (@aws-amplify/pushnotification) is on a deprecation path. Please see the following link for instructions on how to migrate to a new version of Amplify Push Notifications.

https://docs.amplify.aws/lib/push-notifications/migrate-from-previous-version/q/platform/react-native/

deprecated

This package (@aws-amplify/pushnotification) is on a deprecation path. Please see the following link for instructions on how to migrate to a new version of Amplify Push Notifications.

https://docs.amplify.aws/lib/push-notifications/migrate-from-previous-version/q/platform/react-native/

Parameters
- Default value config: PushNotificationConfig = {}
Returns PushNotificationConfig

enable

enable(): void
enable(): void

- Defined in packages/notifications/src/PushNotification/PushNotification.ts:58
Returns void
- Defined in packages/notifications/src/PushNotification/PushNotification.native.ts:152
Returns void

getBadgeCount

getBadgeCount(): Promise<number | null>
getBadgeCount(): Promise<number | null>

- Defined in packages/notifications/src/PushNotification/PushNotification.ts:70
Returns Promise<number | null>
- Defined in packages/notifications/src/PushNotification/PushNotification.native.ts:295
Returns Promise<number | null>

getLaunchNotification

getLaunchNotification(): Promise<PushNotificationMessage>
getLaunchNotification(): Promise<PushNotificationMessage | null>

- Defined in packages/notifications/src/PushNotification/PushNotification.ts:66
Returns Promise<PushNotificationMessage>
- Defined in packages/notifications/src/PushNotification/PushNotification.native.ts:288
Returns Promise<PushNotificationMessage | null>

getModuleName

getModuleName(): NotificationsSubCategory

- Defined in packages/notifications/src/PushNotification/PushNotification.ts:30
Get the name of this module

Returns NotificationsSubCategory

name of this module

getPermissionStatus

getPermissionStatus(): Promise<PushNotificationPermissionStatus>
getPermissionStatus(): Promise<PushNotificationPermissionStatus>

- Defined in packages/notifications/src/PushNotification/PushNotification.ts:78
Returns Promise<PushNotificationPermissionStatus>
- Defined in packages/notifications/src/PushNotification/PushNotification.native.ts:305
Returns Promise<PushNotificationPermissionStatus>

getPluggable

getPluggable(_: string): never
getPluggable(providerName: string): PushNotificationProvider

- Defined in packages/notifications/src/PushNotification/PushNotification.ts:38
Get a plugin from added plugins Get a plugin from added plugins

Parameters
- _: string
Returns never
- Defined in packages/notifications/src/PushNotification/PushNotification.native.ts:104
Get a plugin from added plugins Get a plugin from added plugins

Parameters
- providerName: string
Returns PushNotificationProvider

handleNotificationOpened

handleNotificationOpened(rawMessage: any): void

- Defined in packages/pushnotification/src/PushNotification.ts:365
deprecated

This package (@aws-amplify/pushnotification) is on a deprecation path. Please see the following link for instructions on how to migrate to a new version of Amplify Push Notifications.

https://docs.amplify.aws/lib/push-notifications/migrate-from-previous-version/q/platform/react-native/

Parameters
- rawMessage: any
Returns void

handleNotificationReceived

handleNotificationReceived(rawMessage: any): void

- Defined in packages/pushnotification/src/PushNotification.ts:324
deprecated

This package (@aws-amplify/pushnotification) is on a deprecation path. Please see the following link for instructions on how to migrate to a new version of Amplify Push Notifications.

https://docs.amplify.aws/lib/push-notifications/migrate-from-previous-version/q/platform/react-native/

Parameters
- rawMessage: any
Returns void

identifyUser

identifyUser(): Promise<void[]>
identifyUser(userId: string, userInfo: UserInfo): Promise<void[]>

- Defined in packages/notifications/src/PushNotification/PushNotification.ts:62
Returns Promise<void[]>
- Defined in packages/notifications/src/PushNotification/PushNotification.native.ts:274
Parameters
- userId: string
- userInfo: UserInfo
Returns Promise<void[]>

initializeAndroid

initializeAndroid(): Promise<void>

- Defined in packages/pushnotification/src/PushNotification.ts:162
deprecated

This package (@aws-amplify/pushnotification) is on a deprecation path. Please see the following link for instructions on how to migrate to a new version of Amplify Push Notifications.

https://docs.amplify.aws/lib/push-notifications/migrate-from-previous-version/q/platform/react-native/

Returns Promise<void>

initializeIOS

initializeIOS(): void

- Defined in packages/pushnotification/src/PushNotification.ts:222
deprecated

This package (@aws-amplify/pushnotification) is on a deprecation path. Please see the following link for instructions on how to migrate to a new version of Amplify Push Notifications.

https://docs.amplify.aws/lib/push-notifications/migrate-from-previous-version/q/platform/react-native/

Returns void

onNotification

onNotification(handler: any): void

- Defined in packages/pushnotification/src/PushNotification.ts:113
deprecated

This package (@aws-amplify/pushnotification) is on a deprecation path. Please see the following link for instructions on how to migrate to a new version of Amplify Push Notifications.

https://docs.amplify.aws/lib/push-notifications/migrate-from-previous-version/q/platform/react-native/

Parameters
- handler: any
Returns void

onNotificationOpened

onNotificationOpened(_: OnPushNotificationMessageHandler): any
onNotificationOpened(handler: OnPushNotificationMessageHandler): EventListener<OnPushNotificationMessageHandler>

- Defined in packages/notifications/src/PushNotification/PushNotification.ts:104
deprecated

This package (@aws-amplify/pushnotification) is on a deprecation path. Please see the following link for instructions on how to migrate to a new version of Amplify Push Notifications.

https://docs.amplify.aws/lib/push-notifications/migrate-from-previous-version/q/platform/react-native/

Parameters
- _: OnPushNotificationMessageHandler
Returns any
- Defined in packages/notifications/src/PushNotification/PushNotification.native.ts:354
deprecated

This package (@aws-amplify/pushnotification) is on a deprecation path. Please see the following link for instructions on how to migrate to a new version of Amplify Push Notifications.

https://docs.amplify.aws/lib/push-notifications/migrate-from-previous-version/q/platform/react-native/

Parameters
- handler: OnPushNotificationMessageHandler
Returns EventListener<OnPushNotificationMessageHandler>

onNotificationReceivedInBackground

onNotificationReceivedInBackground(_: OnPushNotificationMessageHandler): any
onNotificationReceivedInBackground(handler: OnPushNotificationMessageHandler): EventListener<OnPushNotificationMessageHandler>

- Defined in packages/notifications/src/PushNotification/PushNotification.ts:88
Parameters
- _: OnPushNotificationMessageHandler
Returns any
- Defined in packages/notifications/src/PushNotification/PushNotification.native.ts:334
Parameters
- handler: OnPushNotificationMessageHandler
Returns EventListener<OnPushNotificationMessageHandler>

onNotificationReceivedInForeground

onNotificationReceivedInForeground(_: OnPushNotificationMessageHandler): any
onNotificationReceivedInForeground(handler: OnPushNotificationMessageHandler): EventListener<OnPushNotificationMessageHandler>

- Defined in packages/notifications/src/PushNotification/PushNotification.ts:94
Parameters
- _: OnPushNotificationMessageHandler
Returns any
- Defined in packages/notifications/src/PushNotification/PushNotification.native.ts:344
Parameters
- handler: OnPushNotificationMessageHandler
Returns EventListener<OnPushNotificationMessageHandler>

onRegister

onRegister(handler: any): void

- Defined in packages/pushnotification/src/PushNotification.ts:145
deprecated

This package (@aws-amplify/pushnotification) is on a deprecation path. Please see the following link for instructions on how to migrate to a new version of Amplify Push Notifications.

https://docs.amplify.aws/lib/push-notifications/migrate-from-previous-version/q/platform/react-native/

Parameters
- handler: any
Returns void

onTokenReceived

onTokenReceived(_: OnTokenReceivedHandler): any
onTokenReceived(handler: OnTokenReceivedHandler): EventListener<OnTokenReceivedHandler>

- Defined in packages/notifications/src/PushNotification/PushNotification.ts:100
Parameters
- _: OnTokenReceivedHandler
Returns any
- Defined in packages/notifications/src/PushNotification/PushNotification.native.ts:361
Parameters
- handler: OnTokenReceivedHandler
Returns EventListener<OnTokenReceivedHandler>

parseMessageData

parseMessageData(rawMessage: any): object

- Defined in packages/pushnotification/src/PushNotification.ts:276
deprecated

This package (@aws-amplify/pushnotification) is on a deprecation path. Please see the following link for instructions on how to migrate to a new version of Amplify Push Notifications.

https://docs.amplify.aws/lib/push-notifications/migrate-from-previous-version/q/platform/react-native/

Parameters
- rawMessage: any
Returns object
- eventSource: any
- eventSourceAttributes: object

parseMessageFromIOS

parseMessageFromIOS(message: any): any

- Defined in packages/pushnotification/src/PushNotification.ts:544
deprecated

This package (@aws-amplify/pushnotification) is on a deprecation path. Please see the following link for instructions on how to migrate to a new version of Amplify Push Notifications.

https://docs.amplify.aws/lib/push-notifications/migrate-from-previous-version/q/platform/react-native/

Parameters
- message: any
Returns any

parseMessagefromAndroid

parseMessagefromAndroid(message: any, from?: any): any

- Defined in packages/pushnotification/src/PushNotification.ts:499
deprecated

This package (@aws-amplify/pushnotification) is on a deprecation path. Please see the following link for instructions on how to migrate to a new version of Amplify Push Notifications.

https://docs.amplify.aws/lib/push-notifications/migrate-from-previous-version/q/platform/react-native/

Parameters
- message: any
- Optional from: any
Returns any

removePluggable

removePluggable(): void
removePluggable(providerName: string): void

- Defined in packages/notifications/src/PushNotification/PushNotification.ts:54
Remove a plugin from added plugins Remove a plugin from added plugins

Returns void
- Defined in packages/notifications/src/PushNotification/PushNotification.native.ts:141
Remove a plugin from added plugins Remove a plugin from added plugins

Parameters
- providerName: string
Returns void

requestIOSPermissions

requestIOSPermissions(options?: object): void

- Defined in packages/pushnotification/src/PushNotification.ts:212
deprecated

This package (@aws-amplify/pushnotification) is on a deprecation path. Please see the following link for instructions on how to migrate to a new version of Amplify Push Notifications.

https://docs.amplify.aws/lib/push-notifications/migrate-from-previous-version/q/platform/react-native/

Parameters
- Default value options: object = { alert: true, badge: true, sound: true }
  - alert: boolean
  - badge: boolean
  - sound: boolean
Returns void

requestPermissions

requestPermissions(_?: PushNotificationPermissions): Promise<boolean>
requestPermissions(permissions?: PushNotificationPermissions): Promise<boolean>

- Defined in packages/notifications/src/PushNotification/PushNotification.ts:82
Parameters
- Optional _: PushNotificationPermissions
Returns Promise<boolean>
- Defined in packages/notifications/src/PushNotification/PushNotification.native.ts:312
Parameters
- Default value permissions: PushNotificationPermissions = {alert: true,badge: true,sound: true,}
Returns Promise<boolean>

setBadgeCount

setBadgeCount(_: number): void
setBadgeCount(count: number): void

- Defined in packages/notifications/src/PushNotification/PushNotification.ts:74
Parameters
- _: number
Returns void
- Defined in packages/notifications/src/PushNotification/PushNotification.native.ts:300
Parameters
- count: number
Returns void

updateEndpoint

updateEndpoint(token: any): void

- Defined in packages/pushnotification/src/PushNotification.ts:402
deprecated

This package (@aws-amplify/pushnotification) is on a deprecation path. Please see the following link for instructions on how to migrate to a new version of Amplify Push Notifications.

https://docs.amplify.aws/lib/push-notifications/migrate-from-previous-version/q/platform/react-native/

Parameters
- token: any
Returns void

Hierarchy

Implements

Index

Constructors

Methods

Constructors

constructor

Returns PushNotification

Methods

_checkIfOpenedByNotification

Parameters

nextAppState: any

handler: any

Returns void

_registerTokenCached

Returns Promise<boolean>

addEventListenerForAndroid

Parameters

event: any

handler: any

Returns void

addEventListenerForIOS

Parameters

event: any

handler: any

Returns void

addPluggable

Parameters

_: PushNotificationProvider

Returns void

Parameters

pluggable: PushNotificationProvider

Returns void

configure

Parameters

Default value _: PushNotificationConfig = {}

Returns PushNotificationConfig

Parameters

Default value config: PushNotificationConfig = {}

Returns PushNotificationConfig

enable

Returns void

Returns void

getBadgeCount

Returns Promise<number | null>

Returns Promise<number | null>

getLaunchNotification

Returns Promise<PushNotificationMessage>

Returns Promise<PushNotificationMessage | null>

getModuleName

Returns NotificationsSubCategory

getPermissionStatus

Returns Promise<PushNotificationPermissionStatus>

Returns Promise<PushNotificationPermissionStatus>

getPluggable

Parameters

_: string

Returns never

Parameters

providerName: string

Returns PushNotificationProvider

handleNotificationOpened

Parameters

rawMessage: any

Returns void

handleNotificationReceived

Parameters

rawMessage: any

Returns void

identifyUser

Returns Promise<void[]>

Parameters

userId: string

userInfo: UserInfo

Returns Promise<void[]>

initializeAndroid

Returns Promise<void>

initializeIOS

Returns void

onNotification