Options
All
  • Public
  • Public/Protected
  • All
Menu

Module "botpress/sdk"

Index

Type aliases

BotConfig

BotConfig: object

Type declaration

  • Optional $schema?: undefined | string
  • Optional author?: undefined | string
  • Optional category?: undefined | string
  • Optional converse?: ConverseConfig
  • defaultLanguage: string
  • Optional description?: undefined | string
  • details: BotDetails
  • Optional dialog?: DialogConfig
  • Optional disabled?: undefined | false | true
  • id: string
  • imports: object
    • contentTypes: string[]
  • languages: string[]
  • locked: boolean
  • Optional logs?: LogsConfig
  • name: string
  • Optional oneflow?: undefined | false | true
  • pipeline_status: BotPipelineStatus
  • Optional private?: undefined | false | true
  • version: string

ContentType

ContentType: object

Type declaration

  • Optional computePreviewText?: undefined | function
  • description: string
  • hidden: boolean
  • id: string
  • jsonSchema: object
  • renderElement: function
      • (data: object, channel: string): any[]
      • Parameters

        • data: object
        • channel: string

        Returns any[]

  • title: string
  • Optional uiSchema?: undefined | object

ConverseConfig

ConverseConfig: object

Type declaration

  • maxMessageLength: number
  • timeout: string

ElementChangedAction

ElementChangedAction: "create" | "update" | "delete"

EventDirection

EventDirection: "incoming" | "outgoing"

EventSearchParams

EventSearchParams: object

Type declaration

  • Optional count?: undefined | number
  • Optional from?: undefined | number
  • Optional sortOrder?: SortOrder[]

FlowNode

FlowNode: object & NodeActions

FlowNodeType

FlowNodeType: "standard" | "skill-call" | "listen" | "say_something" | "success" | "failure" | "trigger" | "execute" | "router" | "action"

GetOrCreateResult

GetOrCreateResult: Promise<object>

KnexExtended

KnexExtended: Knex & KnexExtension

ListenNode

ListenNode: FlowNode & object

Notification

Notification: object

Type declaration

  • botId: string
  • level: string
  • message: string
  • Optional moduleIcon?: undefined | string
  • Optional moduleId?: undefined | string
  • Optional moduleName?: undefined | string
  • Optional redirectUrl?: undefined | string

Pipeline

Pipeline: Stage[]

RolloutStrategy

RolloutStrategy: "anonymous" | "anonymous-invite" | "authenticated" | "authenticated-invite" | "authorized"

RouterCondition

RouterCondition: boolean | function

RouterOptions

RouterOptions: object

Type declaration

SearchParams

SearchParams: object

Type declaration

  • count: number
  • Optional filters?: Filter[]
  • from: number
  • Optional ids?: string[]
  • Optional searchTerm?: undefined | string
  • Optional sortOrder?: SortOrder[]

SkillFlow

SkillFlow: Partial<Flow> & Pick<Required<Flow>, "nodes">

SkillFlowNode

SkillFlowNode: Partial<ListenNode> & Pick<Required<ListenNode>, "name"> & Partial<TriggerNode>

StageAction

StageAction: "promote_copy" | "promote_move"

State

State: any

StrategyUser

StrategyUser: object & UserInfo

TriggerNode

TriggerNode: FlowNode & object

User

User: object

Type declaration

  • attributes: any
  • channel: string
  • createdOn: Date
  • id: string
  • Optional otherChannels?: User[]
  • updatedOn: Date

Variables

Const database

database: KnexExtended

Const logger

logger: Logger

Const version

version: string

Generated using TypeDoc