FileService class

Warning

This API is now obsolete.

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

Defines an file service connection.

Extends

Constructors

FileService(IFileService)

Creates a new FileService instance.

Properties

id

Unique Id for the service.

name

Friendly name for the service.

path

File path.

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.

toJSON()

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

Constructor Details

FileService(IFileService)

Creates a new FileService instance.

new FileService(source?: IFileService)

Parameters

source
IFileService

(Optional) JSON based service definition.

Property Details

id

Unique Id for the service.

id: string

Property Value

string

name

Friendly name for the service.

name: string

Property Value

string

path

File path.

path: string

Property Value

string

type

type?: ServiceTypes

Property Value

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.

toJSON()

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

function toJSON()

Returns