BotConfigurationBase class

Package:

botframework-config

Warning

This API is now deprecated.

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

Constructors

BotConfigurationBase()

Creates a new BotConfigurationBase instance.

Properties

description
name
padlock
services
version

Methods

connectService(IConnectedService)	Connect a service to the bot file.
disconnectService(string)	Remove service by id.
disconnectServiceByNameOrId(string)	Remove service by name or id.
findService(string)	Find service by id.
findServiceByNameOrId(string)	Find service by name or id.
fromJSON(Partial<IBotConfiguration>)	Loads a new BotConfigurationBase instance given a JSON based configuration.
serviceFromJSON(IConnectedService)	Loads a ConnectedService instance given a JSON based service configuration.
toJSON()	Creates a JSON based version of the current bot.

Constructor Details

BotConfigurationBase()

Creates a new BotConfigurationBase instance.

new BotConfigurationBase()

Property Details

description

description: string

Property Value

string

name

name: string

Property Value

string

padlock

padlock: string

Property Value

string

services

services: IConnectedService[]

Property Value

IConnectedService[]

version

version: string

Property Value

string

Method Details

connectService(IConnectedService)

Connect a service to the bot file.

function connectService(newService: IConnectedService): string

Parameters

newService

IConnectedService

Service to add.

Returns

string

Assigned ID for the service.

disconnectService(string)

Remove service by id.

function disconnectService(id: string)

Parameters

id

string

ID of the service to remove.

disconnectServiceByNameOrId(string)

Remove service by name or id.

function disconnectServiceByNameOrId(nameOrId: string): IConnectedService

Parameters

nameOrId

string

Name or ID of the service to remove.

Returns

IConnectedService

The removed IConnectedService based on the provided name or id.

findService(string)

Find service by id.

function findService(id: string): IConnectedService

Parameters

id

string

ID of the service to find.

Returns

IConnectedService

The IConnectedService based on the provided id.

findServiceByNameOrId(string)

Find service by name or id.

function findServiceByNameOrId(nameOrId: string): IConnectedService

Parameters

nameOrId

string

Name or ID of the service to find.

Returns

IConnectedService

The IConnectedService based on the provided name or id.

fromJSON(Partial<IBotConfiguration>)

Loads a new BotConfigurationBase instance given a JSON based configuration.

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

Parameters

source

Partial<IBotConfiguration>

JSON based configuration.

Returns

BotConfigurationBase

A new BotConfigurationBase instance.

serviceFromJSON(IConnectedService)

Loads a ConnectedService instance given a JSON based service configuration.

static function serviceFromJSON(service: IConnectedService): ConnectedService

Parameters

service

IConnectedService

JSON based service configuration.

Returns

ConnectedService

A new ConnectedService instance.

toJSON()

Creates a JSON based version of the current bot.

function toJSON(): IBotConfiguration

Returns

IBotConfiguration

An IBotConfiguration JSON.