GenericService class

Package:

botframework-config

Warning

This API is now deprecated.

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

Defines a generic service connection.

Extends

ConnectedService

Constructors

GenericService(IGenericService)

Creates a new GenericService instance.

Properties

configuration	Named/value configuration data.
url	Deep link to service.

Inherited Properties

id	Unique Id for the service.
name	Friendly name for the service.
type

Methods

decrypt(string, (value: string, secret: string) => string)	Decrypt properties on this service.
encrypt(string, (value: string, secret: string) => string)	Encrypt properties on this service.

Inherited Methods

toJSON()

Creates a JSON based version of the model for saving to disk.

Constructor Details

GenericService(IGenericService)

Creates a new GenericService instance.

new GenericService(source?: IGenericService)

Parameters

source

IGenericService

(Optional) JSON based service definition.

Property Details

configuration

Named/value configuration data.

configuration: [key: string]: string

Property Value

[key: string]: string

url

Deep link to service.

url: string

Property Value

string

Inherited Property Details

id

Unique Id for the service.

id: string

Property Value

string

Inherited From ConnectedService.id

name

Friendly name for the service.

name: string

Property Value

string

Inherited From ConnectedService.name

type

type?: ServiceTypes

Property Value

ServiceTypes

Inherited From ConnectedService.type

Method Details

decrypt(string, (value: string, secret: string) => string)

Decrypt properties on this service.

function decrypt(secret: string, decryptString: (value: string, secret: string) => string)

Parameters

secret

string

Secret to use to decrypt.

decryptString

(value: string, secret: string) => string

Function called to decrypt an individual value.

encrypt(string, (value: string, secret: string) => string)

Encrypt properties on this service.

function encrypt(secret: string, encryptString: (value: string, secret: string) => string)

Parameters

secret

string

Secret to use to encrypt.

encryptString

(value: string, secret: string) => string

Function called to encrypt an individual value.

Inherited Method Details

toJSON()

Creates a JSON based version of the model for saving to disk.

function toJSON(): IConnectedService

Returns

IConnectedService

An IConnectedService JSON.

Inherited From ConnectedService.toJSON