SkillHandler class

A Bot Framework Handler for skills.

Extends

Constructors

SkillHandler(BotAdapter, ActivityHandlerBase, SkillConversationIdFactoryBase, ICredentialProvider, AuthenticationConfiguration, string)

Initializes a new instance of the SkillHandler class.

Properties

SkillConversationReferenceKey

Used to access the CovnersationReference sent from the Skill to the Parent.

Methods

handleCreateConversation(string, ConversationParameters)
handleDeleteActivity(string, string, string)
handleDeleteConversationMember(string, string, string)
handleGetActivityMembers(string, string, string)
handleGetConversationMembers(string, string)
handleGetConversationPagedMembers(string, string, number, string)
handleGetConversations(string, string, string)
handleReplyToActivity(string, string, string, Activity)
handleSendConversationHistory(string, string, Transcript)
handleSendToConversation(string, string, Activity)
handleUpdateActivity(string, string, string, Activity)
handleUploadAttachment(string, string, AttachmentData)

Constructor Details

SkillHandler(BotAdapter, ActivityHandlerBase, SkillConversationIdFactoryBase, ICredentialProvider, AuthenticationConfiguration, string)

Initializes a new instance of the SkillHandler class.

new SkillHandler(adapter: BotAdapter, bot: ActivityHandlerBase, conversationIdFactory: SkillConversationIdFactoryBase, credentialProvider: ICredentialProvider, authConfig: AuthenticationConfiguration, channelService?: string)

Parameters

adapter
BotAdapter

An instance of the BotAdapter that will handle the request.

bot
ActivityHandlerBase

The ActivityHandlerBase instance.

conversationIdFactory
SkillConversationIdFactoryBase

A SkillConversationIdFactoryBase to unpack the conversation ID and map it to the calling bot.

credentialProvider
ICredentialProvider

The credential provider.

authConfig
AuthenticationConfiguration

The authentication configuration.

channelService
string

The string indicating if the bot is working in Public Azure or in Azure Government (https://aka.ms/AzureGovDocs).

Property Details

SkillConversationReferenceKey

Used to access the CovnersationReference sent from the Skill to the Parent.

SkillConversationReferenceKey: symbol

Property Value

symbol

Remarks

The value is the same as the SkillConversationReferenceKey exported from botbuilder-core.

Method Details

handleCreateConversation(string, ConversationParameters)

function handleCreateConversation(authHeader: string, parameters: ConversationParameters)

Parameters

authHeader
string
parameters
ConversationParameters

Returns

Promise<ConversationResourceResponse>

handleDeleteActivity(string, string, string)

function handleDeleteActivity(authHeader: string, conversationId: string, activityId: string)

Parameters

authHeader
string
conversationId
string
activityId
string

Returns

Promise<void>

handleDeleteConversationMember(string, string, string)

function handleDeleteConversationMember(authHeader: string, conversationId: string, memberId: string)

Parameters

authHeader
string
conversationId
string
memberId
string

Returns

Promise<void>

handleGetActivityMembers(string, string, string)

function handleGetActivityMembers(authHeader: string, conversationId: string, activityId: string)

Parameters

authHeader
string
conversationId
string
activityId
string

Returns

Promise<ChannelAccount[]>

handleGetConversationMembers(string, string)

function handleGetConversationMembers(authHeader: string, conversationId: string)

Parameters

authHeader
string
conversationId
string

Returns

Promise<ChannelAccount[]>

handleGetConversationPagedMembers(string, string, number, string)

function handleGetConversationPagedMembers(authHeader: string, conversationId: string, pageSize?: number, continuationToken?: string)

Parameters

authHeader
string
conversationId
string
pageSize
number
continuationToken
string

Returns

Promise<PagedMembersResult>

handleGetConversations(string, string, string)

function handleGetConversations(authHeader: string, conversationId: string, continuationToken?: string)

Parameters

authHeader
string
conversationId
string
continuationToken
string

Returns

Promise<ConversationsResult>

handleReplyToActivity(string, string, string, Activity)

function handleReplyToActivity(authHeader: string, conversationId: string, activityId: string, activity: Activity)

Parameters

authHeader
string
conversationId
string
activityId
string
activity
Activity

Returns

Promise<ResourceResponse>

handleSendConversationHistory(string, string, Transcript)

function handleSendConversationHistory(authHeader: string, conversationId: string, transcript: Transcript)

Parameters

authHeader
string
conversationId
string
transcript
Transcript

Returns

Promise<ResourceResponse>

handleSendToConversation(string, string, Activity)

function handleSendToConversation(authHeader: string, conversationId: string, activity: Activity)

Parameters

authHeader
string
conversationId
string
activity
Activity

Returns

Promise<ResourceResponse>

handleUpdateActivity(string, string, string, Activity)

function handleUpdateActivity(authHeader: string, conversationId: string, activityId: string, activity: Activity)

Parameters

authHeader
string
conversationId
string
activityId
string
activity
Activity

Returns

Promise<ResourceResponse>

handleUploadAttachment(string, string, AttachmentData)

function handleUploadAttachment(authHeader: string, conversationId: string, attachmentUpload: AttachmentData)

Parameters

authHeader
string
conversationId
string
attachmentUpload
AttachmentData

Returns

Promise<ResourceResponse>