Conversation class

Package:

@microsoft/agents-hosting

A serializable pair of a ConversationReference and the JWT claims needed to authenticate proactive calls on behalf of this agent.

Instances are stored in and retrieved from the proactive storage backend. The identity getter produces the JwtPayload shape expected by adapter.continueConversation().

Constructors

Conversation(ConversationClaims, ConversationReference)
Conversation(TurnContext)

Properties

claims
identity	Returns a JwtPayload-compatible object for passing to adapter.continueConversation() as botAppIdOrIdentity.
reference

Methods

toJson()	Returns a JSON string of { reference, claims } — suitable for use in HTTP request bodies when passing a conversation to another service.
validate()	Throws if any required field is missing. Called by Proactive.storeConversation() before writing to storage.

Constructor Details

Conversation(ConversationClaims, ConversationReference)

new Conversation(claims: ConversationClaims, reference: ConversationReference)

Parameters

claims

ConversationClaims

reference

ConversationReference

Conversation(TurnContext)

new Conversation(context: TurnContext)

Parameters

context

TurnContext

Property Details

claims

claims: ConversationClaims

Property Value

ConversationClaims

identity

Returns a JwtPayload-compatible object for passing to adapter.continueConversation() as botAppIdOrIdentity.

JwtPayload identity

Property Value

JwtPayload

reference

reference: ConversationReference

Property Value

ConversationReference

Method Details

toJson()

Returns a JSON string of { reference, claims } — suitable for use in HTTP request bodies when passing a conversation to another service.

function toJson(): string

Returns

string

validate()

Throws if any required field is missing. Called by Proactive.storeConversation() before writing to storage.

function validate()