BotConfigurationBase class

包:

botframework-config

警告

现已弃用此 API。

See https://aka.ms/bot-file-basics for more information.

构造函数

BotConfigurationBase()

创建新的 BotConfigurationBase 实例。

属性

description
name
padlock
services
version

方法

connectService(IConnectedService)	将服务连接到机器人文件。
disconnectService(string)	按 ID 删除服务。
disconnectServiceByNameOrId(string)	按名称或 ID 删除服务。
findService(string)	按 ID 查找服务。
findServiceByNameOrId(string)	按名称或 ID 查找服务。
fromJSON(Partial<IBotConfiguration>)	在给定基于 JSON 的配置的情况下加载新的 BotConfigurationBase 实例。
serviceFromJSON(IConnectedService)	在给定基于 JSON 的服务配置的情况下加载 ConnectedService 实例。
toJSON()	创建基于 JSON 的当前机器人版本。

构造函数详细信息

BotConfigurationBase()

创建新的 BotConfigurationBase 实例。

new BotConfigurationBase()

属性详细信息

description

description: string

属性值

string

name

name: string

属性值

string

padlock

padlock: string

属性值

string

services

services: IConnectedService[]

属性值

IConnectedService[]

version

version: string

属性值

string

方法详细信息

connectService(IConnectedService)

将服务连接到机器人文件。

function connectService(newService: IConnectedService): string

参数

newService

IConnectedService

要添加的服务。

返回

string

服务的分配 ID。

disconnectService(string)

按 ID 删除服务。

function disconnectService(id: string)

参数

id

string

要删除的服务的 ID。

disconnectServiceByNameOrId(string)

按名称或 ID 删除服务。

function disconnectServiceByNameOrId(nameOrId: string): IConnectedService

参数

nameOrId

string

要删除的服务的名称或 ID。

返回

IConnectedService

已删除的 IConnectedService 基于提供的名称或 ID。

findService(string)

按 ID 查找服务。

function findService(id: string): IConnectedService

参数

id

string

要查找的服务的 ID。

返回

IConnectedService

基于提供的 ID 的 IConnectedService。

findServiceByNameOrId(string)

按名称或 ID 查找服务。

function findServiceByNameOrId(nameOrId: string): IConnectedService

参数

nameOrId

string

要查找的服务的名称或 ID。

返回

IConnectedService

基于提供的名称或 ID 的 IConnectedService。

fromJSON(Partial<IBotConfiguration>)

在给定基于 JSON 的配置的情况下加载新的 BotConfigurationBase 实例。

static function fromJSON(source?: Partial<IBotConfiguration>): BotConfigurationBase

参数

source

Partial<IBotConfiguration>

基于 JSON 的配置。

返回

BotConfigurationBase

新的 BotConfigurationBase 实例。

serviceFromJSON(IConnectedService)

在给定基于 JSON 的服务配置的情况下加载 ConnectedService 实例。

static function serviceFromJSON(service: IConnectedService): ConnectedService

参数

service

IConnectedService

基于 JSON 的服务配置。

返回

ConnectedService

新的 ConnectedService 实例。

toJSON()

创建基于 JSON 的当前机器人版本。

function toJSON(): IBotConfiguration

返回

IBotConfiguration

IBotConfiguration JSON。