InternalInAppMessagingClass | amplify-js

Hierarchy

InternalInAppMessagingClass
- InAppMessaging

Implements

InAppMessagingInterface

Index

Constructors

constructor

Methods

Constructors

constructor

new InternalInAppMessagingClass(): InternalInAppMessagingClass

- Defined in packages/notifications/src/internals/InternalInAppMessaging.ts:46
Returns InternalInAppMessagingClass

Methods

addPluggable

addPluggable(pluggable: InAppMessagingProvider): void

- Defined in packages/notifications/src/internals/InternalInAppMessaging.ts:112
Add plugin into InAppMessaging

Parameters
- pluggable: InAppMessagingProvider
  
  an instance of the plugin
Returns void

clearMessages

clearMessages(): Promise<void[]>

- Defined in packages/notifications/src/internals/InternalInAppMessaging.ts:170
Returns Promise<void[]>

configure

configure(__namedParameters?: object): InAppMessagingConfig

- Defined in packages/notifications/src/internals/InternalInAppMessaging.ts:57
Configure InAppMessaging

Parameters
- Default value __namedParameters: object = {}
  - notificationsConfig: object
    - Optional InAppMessaging?: InAppMessagingConfig
    - Optional PushNotification?: PushNotificationConfig
Returns InAppMessagingConfig

dispatchEvent

dispatchEvent(event: InAppMessagingEvent): Promise<void>

- Defined in packages/notifications/src/internals/InternalInAppMessaging.ts:179
Parameters
- event: InAppMessagingEvent
Returns Promise<void>

getModuleName

getModuleName(): NotificationsSubCategory | InternalNotificationsSubCategory

- Defined in packages/notifications/src/internals/InternalInAppMessaging.ts:87
Get the name of this module

Returns NotificationsSubCategory | InternalNotificationsSubCategory

name of this module

getPluggable

getPluggable(providerName: string): InAppMessagingProvider

- Defined in packages/notifications/src/internals/InternalInAppMessaging.ts:95
Get a plugin from added plugins

Parameters
- providerName: string
  
  the name of the plugin to get
Returns InAppMessagingProvider

identifyUser

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

- Defined in packages/notifications/src/internals/InternalInAppMessaging.ts:198
Parameters
- userId: string
- userInfo: UserInfo
- Optional customUserAgentDetails: CustomUserAgentDetails
Returns Promise<void[]>

notifyMessageInteraction

notifyMessageInteraction(message: InAppMessage, type: InAppMessageInteractionEvent): void

- Defined in packages/notifications/src/internals/InternalInAppMessaging.ts:245
Parameters
- message: InAppMessage
- type: InAppMessageInteractionEvent
Returns void

onMessageActionTaken

onMessageActionTaken(handler: OnMessageInteractionEventHandler): EventListener<OnMessageInteractionEventHandler>

- Defined in packages/notifications/src/internals/InternalInAppMessaging.ts:237
Parameters
- handler: OnMessageInteractionEventHandler
Returns EventListener<OnMessageInteractionEventHandler>

onMessageDismissed

onMessageDismissed(handler: OnMessageInteractionEventHandler): EventListener<OnMessageInteractionEventHandler>

- Defined in packages/notifications/src/internals/InternalInAppMessaging.ts:232
Parameters
- handler: OnMessageInteractionEventHandler
Returns EventListener<OnMessageInteractionEventHandler>

onMessageDisplayed

onMessageDisplayed(handler: OnMessageInteractionEventHandler): EventListener<OnMessageInteractionEventHandler>

- Defined in packages/notifications/src/internals/InternalInAppMessaging.ts:227
Parameters
- handler: OnMessageInteractionEventHandler
Returns EventListener<OnMessageInteractionEventHandler>

onMessageReceived

onMessageReceived(handler: OnMessageInteractionEventHandler): EventListener<OnMessageInteractionEventHandler>

- Defined in packages/notifications/src/internals/InternalInAppMessaging.ts:222
Parameters
- handler: OnMessageInteractionEventHandler
Returns EventListener<OnMessageInteractionEventHandler>

removePluggable

removePluggable(providerName: string): void

- Defined in packages/notifications/src/internals/InternalInAppMessaging.ts:132
Remove a plugin from added plugins

Parameters
- providerName: string
  
  the name of the plugin to remove
Returns void

setConflictHandler

setConflictHandler(handler: InAppMessageConflictHandler): void

- Defined in packages/notifications/src/internals/InternalInAppMessaging.ts:252
Parameters
- handler: InAppMessageConflictHandler
Returns void

syncMessages

syncMessages(customUserAgentDetails?: CustomUserAgentDetails): Promise<void[]>

- Defined in packages/notifications/src/internals/InternalInAppMessaging.ts:148
Get the map resources that are currently available through the provider

Parameters
- Optional customUserAgentDetails: CustomUserAgentDetails
  
  optional parameter to send user agent details
Returns Promise<void[]>
- Array of available map resources