AWSLexV2Provider | amplify-js

Hierarchy

AbstractInteractionsProvider
- AWSLexV2Provider

Implements

InteractionsProvider

Index

Constructors

constructor

Properties

_config

Accessors

options

Methods

Constructors

constructor

new AWSLexV2Provider(options?: InteractionsOptions): AWSLexV2Provider

Overrides AbstractInteractionsProvider.constructor
- Defined in packages/interactions/src/Providers/AWSLexV2Provider.ts:58
Initialize Interactions with AWS configurations

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

Properties

Protected _config

_config: InteractionsOptions

Accessors

Protected options

options:

Methods

configure

configure(config?: AWSLexV2ProviderOptions): AWSLexV2ProviderOptions

Overrides AbstractInteractionsProvider.configure
- Defined in packages/interactions/src/Providers/AWSLexV2Provider.ts:82
Configure Interactions part with aws configuration

Parameters
- Default value config: AWSLexV2ProviderOptions = {}
  
  Configuration of the Interactions
Returns AWSLexV2ProviderOptions
- Current configuration

getCategory

getCategory(): string

Implementation of InteractionsProvider.getCategory

Inherited from AbstractInteractionsProvider.getCategory
- Defined in packages/interactions/src/Providers/InteractionsProvider.ts:30
Returns string

getProviderName

getProviderName(): string

Implementation of InteractionsProvider.getProviderName

Overrides AbstractInteractionsProvider.getProviderName
- Defined in packages/interactions/src/Providers/AWSLexV2Provider.ts:73
get provider name of the plugin

Returns string

name of the provider

onComplete

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

Overrides AbstractInteractionsProvider.onComplete
- Defined in packages/interactions/src/Providers/AWSLexV2Provider.ts:167
Attach a onComplete callback function to a bot. The callback is called once the bot's intent is fulfilled

Parameters
- botname: string
  
  Bot name to attach the onComplete callback
- callback: function
  
  called when Intent Fulfilled
  - - (err: Error | null, confirmation: InteractionsResponse): void
    - Parameters
      - err: Error | null
      - confirmation: InteractionsResponse
      Returns void
Returns void

sendMessage

sendMessage(botname: string, message: string | InteractionsMessage): Promise<InteractionsResponse>

Implementation of InteractionsProvider.sendMessage

Overrides AbstractInteractionsProvider.sendMessage
- Defined in packages/interactions/src/Providers/AWSLexV2Provider.ts:112
Send a message to a bot

async

Parameters
- botname: string
  
  Bot name to send the message
- message: string | InteractionsMessage
  
  message to send to the bot
Returns Promise<InteractionsResponse>

A promise resolves to the response from the bot