InteractionsClass | amplify-js

Hierarchy

InteractionsClass

Index

Constructors

constructor

Methods

Constructors

constructor

new InteractionsClass(options?: InteractionsOptions): InteractionsClass

- Defined in packages/interactions/src/Interactions.ts:17
Initialize PubSub with AWS configurations

Parameters
- Default value options: InteractionsOptions = {}
  
  Configuration object for Interactions
Returns InteractionsClass

Methods

addPluggable

addPluggable(pluggable: InteractionsProvider): void

- Defined in packages/interactions/src/Interactions.ts:82
Parameters
- pluggable: InteractionsProvider
Returns void

configure

configure(options: InteractionsOptions): InteractionsOptions

- Defined in packages/interactions/src/Interactions.ts:39
Parameters
- options: InteractionsOptions
  
  Configuration object for Interactions
Returns InteractionsOptions
- The current configuration

getModuleName

getModuleName(): string

- Defined in packages/interactions/src/Interactions.ts:30
Returns string

onComplete

onComplete(botname: string, callback: function): void

- Defined in packages/interactions/src/Interactions.ts:140
Parameters
- botname: string
- callback: function
  - - (err: any, confirmation: any): void
    - Parameters
      - err: any
      - confirmation: any
      Returns void
Returns void

send

send(botname: string, message: string): Promise<InteractionsResponse>
send(botname: string, message: InteractionsMessage): Promise<InteractionsResponse>
send(botname: string, message: object): Promise<InteractionsResponse>

- Defined in packages/interactions/src/Interactions.ts:107
Parameters
- botname: string
- message: string
Returns Promise<InteractionsResponse>
- Defined in packages/interactions/src/Interactions.ts:111
Parameters
- botname: string
- message: InteractionsMessage
Returns Promise<InteractionsResponse>
- Defined in packages/interactions/src/Interactions.ts:115
Parameters
- botname: string
- message: object
Returns Promise<InteractionsResponse>