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)	Удаление службы по идентификатору.
disconnectServiceByNameOrId(string)	Удаление службы по имени или идентификатору.
findService(string)	Поиск службы по идентификатору.
findServiceByNameOrId(string)	Поиск службы по имени или идентификатору.
fromJSON(Partial<IBotConfiguration>)	Загружает новый экземпляр BotConfigurationBase с конфигурацией на основе JSON.
serviceFromJSON(IConnectedService)	Загружает экземпляр ConnectedService с конфигурацией службы на основе JSON.
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

Назначенный идентификатор для службы.

disconnectService(string)

Удаление службы по идентификатору.

function disconnectService(id: string)

Параметры

id

string

Идентификатор службы для удаления.

disconnectServiceByNameOrId(string)

Удаление службы по имени или идентификатору.

function disconnectServiceByNameOrId(nameOrId: string): IConnectedService

Параметры

nameOrId

string

Имя или идентификатор службы для удаления.

Возвращаемое значение

IConnectedService

Удаленная служба IConnectedService на основе предоставленного имени или идентификатора.

findService(string)

Поиск службы по идентификатору.

function findService(id: string): IConnectedService

Параметры

id

string

Идентификатор службы для поиска.

Возвращаемое значение

IConnectedService

IConnectedService на основе предоставленного идентификатора.

findServiceByNameOrId(string)

Поиск службы по имени или идентификатору.

function findServiceByNameOrId(nameOrId: string): IConnectedService

Параметры

nameOrId

string

Имя или идентификатор службы для поиска.

Возвращаемое значение

IConnectedService

IConnectedService на основе предоставленного имени или идентификатора.

fromJSON(Partial<IBotConfiguration>)

Загружает новый экземпляр BotConfigurationBase с конфигурацией на основе JSON.

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

Параметры

source

Partial<IBotConfiguration>

Конфигурация на основе JSON.

Возвращаемое значение

BotConfigurationBase

Новый экземпляр BotConfigurationBase.

serviceFromJSON(IConnectedService)

Загружает экземпляр ConnectedService с конфигурацией службы на основе JSON.

static function serviceFromJSON(service: IConnectedService): ConnectedService

Параметры

service

IConnectedService

Конфигурация службы на основе JSON.

Возвращаемое значение

ConnectedService

Новый экземпляр ConnectedService.

toJSON()

Создает версию на основе JSON текущего бота.

function toJSON(): IBotConfiguration

Возвращаемое значение

IBotConfiguration

JSON-файл IBotConfiguration.