@aws-amplify/interactions

  • Version 4.0.7
  • Published
  • 2.89 MB
  • 2 dependencies
  • Apache-2.0 license

Install

npm i @aws-amplify/interactions
yarn add @aws-amplify/interactions
pnpm add @aws-amplify/interactions

Overview

Interactions category of aws-amplify

Index

Variables

variable Interactions

const Interactions: InteractionsClass;

    Classes

    class AWSLexProvider

    class AWSLexProvider extends AbstractInteractionsProvider {}

      constructor

      constructor(options?: InteractionsOptions);

        method getProviderName

        getProviderName: () => string;

          method onComplete

          onComplete: (botname: string, callback: any) => void;

            method reportBotStatus

            reportBotStatus: (data: any, botname: any) => void;

              method sendMessage

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

                Interfaces

                interface InteractionsOptions

                interface InteractionsOptions {}

                  index signature

                  [key: string]: any;

                    interface InteractionsProvider

                    interface InteractionsProvider {}

                      method configure

                      configure: (config: object) => object;

                        method getCategory

                        getCategory: () => string;

                          method getProviderName

                          getProviderName: () => string;

                            method onComplete

                            onComplete: (
                            botname: string,
                            callback: (err: any, confirmation: InteractionsResponse) => void
                            ) => any;

                              method sendMessage

                              sendMessage: (botname: string, message: string | Object) => Promise<object>;

                                interface InteractionsProviders

                                interface InteractionsProviders {}

                                  index signature

                                  [key: string]: InteractionsProvider;

                                    Type Aliases

                                    type InteractionsMessage

                                    type InteractionsMessage = InteractionsTextMessage | InteractionsVoiceMessage;

                                      type InteractionsResponse

                                      type InteractionsResponse = {
                                      [key: string]: any;
                                      };

                                        type InteractionsTextMessage

                                        type InteractionsTextMessage = {
                                        content: string;
                                        options: {
                                        messageType: 'text';
                                        };
                                        };

                                          type InteractionsVoiceMessage

                                          type InteractionsVoiceMessage = {
                                          content: object;
                                          options: {
                                          messageType: 'voice';
                                          };
                                          };

                                            Package Files (6)

                                            Dependencies (2)

                                            Dev Dependencies (0)

                                            No dev dependencies.

                                            Peer Dependencies (0)

                                            No peer dependencies.

                                            Badge

                                            To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                                            You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@aws-amplify/interactions.

                                            • Markdown
                                              [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@aws-amplify/interactions)
                                            • HTML
                                              <a href="https://www.jsdocs.io/package/@aws-amplify/interactions"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>