Edit

Share via

SkillConversationIdFactoryBase class

  • Reference
Package:
botbuilder-core

Defines the methods of a factory that is used to create unique conversation IDs for skill conversations.

Methods

createSkillConversationId(ConversationReference)

Creates a conversation ID for a skill conversation based on the caller's ConversationReference.
createSkillConversationIdWithOptions(SkillConversationIdFactoryOptions)

Creates a conversation ID for a skill conversation based on the caller's ConversationReference.
deleteConversationReference(string)

Deletes a ConversationReference.
getConversationReference(string)

Gets the ConversationReference created using createSkillConversationId() for a skillConversationId.
getSkillConversationReference(string)

Gets the SkillConversationReference created using createSkillConversationId() for a skillConversationId.

Method Details

createSkillConversationId(ConversationReference)

Warning

This API is now deprecated.

Method is deprecated, please use createSkillConversationIdWithOptions() with SkillConversationIdFactoryOptions instead.

Creates a conversation ID for a skill conversation based on the caller's ConversationReference.

function createSkillConversationId(_conversationReference: ConversationReference): Promise<string>

Parameters

_conversationReference

ConversationReference

The skill's caller ConversationReference.

Returns

Promise<string>

Remarks

It should be possible to use the returned string on a request URL and it should not contain special characters. Returns A unique conversation ID used to communicate with the skill.

createSkillConversationIdWithOptions(SkillConversationIdFactoryOptions)

Creates a conversation ID for a skill conversation based on the caller's ConversationReference.

function createSkillConversationIdWithOptions(_options: SkillConversationIdFactoryOptions): Promise<string>

Parameters

_options
SkillConversationIdFactoryOptions

The SkillConversationIdFactoryOptions to use.

Returns

Promise<string>

Remarks

It should be possible to use the returned string on a request URL and it should not contain special characters. Returns A unique conversation ID used to communicate with the skill.

deleteConversationReference(string)

Deletes a ConversationReference.

function deleteConversationReference(skillConversationId: string): Promise<void>

Parameters

skillConversationId

string

A skill conversationId created using createSkillConversationId().

Returns

Promise<void>

getConversationReference(string)

Warning

This API is now deprecated.

Method is deprecated, please use getSkillConversationReference() instead.

Gets the ConversationReference created using createSkillConversationId() for a skillConversationId.

function getConversationReference(_skillConversationId: string): Promise<ConversationReference>

Parameters

_skillConversationId

string

A skill conversationId created using createSkillConversationId().

Returns

Promise<ConversationReference>

Remarks

Returns The caller's ConversationReference for a skillConversationId. null if not found.

getSkillConversationReference(string)

Gets the SkillConversationReference created using createSkillConversationId() for a skillConversationId.

function getSkillConversationReference(_skillConversationId: string): Promise<SkillConversationReference>

Parameters

_skillConversationId

string

Gets the SkillConversationReference used during createSkillConversationId for a skillConversationId.

Returns

Promise<SkillConversationReference>