Class TurnContext

constructor

• new TurnContext(
      adapterOrContext: BaseAdapter,
      request: Activity,
      identity?: JwtPayload,
  ): TurnContext

  Initializes a new instance of the TurnContext class.

  Parameters

  • adapterOrContext: BaseAdapter

    The adapter that created this context, or another TurnContext to clone

  • request: Activity

    The activity for the turn (required when first parameter is an adapter)

  • Optionalidentity: JwtPayload

  Returns TurnContext

• new TurnContext(adapterOrContext: TurnContext): TurnContext

  Parameters

  • adapterOrContext: TurnContext

  Returns TurnContext

ReadonlybufferedReplyActivities

activity

• get activity(): Activity

  Gets the incoming activity that started this turn.

  Returns Activity

  Remarks

  This is the activity that was received from the user or channel and triggered the creation of this context.

adapter

• get adapter(): BaseAdapter

  Gets the adapter that created this context.

  Returns BaseAdapter

  Remarks

  The adapter is responsible for sending and receiving activities to and from the user's channel.

identity

• get identity(): JwtPayload

  Returns JwtPayload

locale

• get locale(): string | undefined

  Gets or sets the locale for the turn.

  Returns string | undefined

  Remarks

  The locale affects language-dependent operations like formatting dates or numbers.

• set locale(value: string | undefined): void

  Parameters

  • value: string | undefined

  Returns void

responded

• get responded(): boolean

  Gets or sets whether the turn has sent a response to the user.

  Returns boolean

  Remarks

  This is used to track whether the agent has responded to the user's activity. Once set to true, it cannot be set back to false.

• set responded(value: boolean): void

  Parameters

  • value: boolean

  Returns void

streamingResponse

• get streamingResponse(): StreamingResponse

  Returns StreamingResponse

turnState

• get turnState(): TurnContextStateCollection

  Gets the turn state collection for storing data during the turn.

  Returns TurnContextStateCollection

  Remarks

  The turn state collection provides a dictionary-like interface for storing arbitrary data that needs to be accessible during the processing of the current turn.

deleteActivity

• deleteActivity(idOrReference: string | ConversationReference): Promise<void>

  Deletes an activity from the conversation.

  Parameters

  • idOrReference: string | ConversationReference

    The ID of the activity to delete or a conversation reference

  Returns Promise<void>

  A promise that resolves when the activity has been deleted

getAttachment

• getAttachment(attachmentId: string, viewId: string): Promise<ReadableStream>

  Parameters

  • attachmentId: string

    The ID of the attachment

  • viewId: string

    The view to get

  Returns Promise<ReadableStream>

  A promise that resolves to a readable stream of the attachment content

  Deprecated

  This function will not be supported in future versions. Use TurnContext.turnState.get(CloudAdapter.ConnectorClientKey). Gets the content of an attachment.

getAttachmentInfo

• getAttachmentInfo(attachmentId: string): Promise<AttachmentInfo>

  Parameters

  • attachmentId: string

    The ID of the attachment

  Returns Promise<AttachmentInfo>

  A promise that resolves to the attachment information

  Deprecated

  This function will not be supported in future versions. Use TurnContext.turnState.get(CloudAdapter.ConnectorClientKey). Gets information about an attachment.

onDeleteActivity

• onDeleteActivity(handler: DeleteActivityHandler): this

  Registers a handler for intercepting activity deletions.

  Parameters

  • handler: DeleteActivityHandler

    The handler to register

  Returns this

  The current TurnContext instance for chaining

onSendActivities

• onSendActivities(handler: SendActivitiesHandler): this

  Registers a handler for intercepting and processing activities being sent.

  Parameters

  • handler: SendActivitiesHandler

    The handler to register

  Returns this

  The current TurnContext instance for chaining

  Remarks

  This method follows a middleware pattern, allowing multiple handlers to be chained together. Handlers can modify activities or inject new ones.

onUpdateActivity

• onUpdateActivity(handler: UpdateActivityHandler): this

  Registers a handler for intercepting activity updates.

  Parameters

  • handler: UpdateActivityHandler

    The handler to register

  Returns this

  The current TurnContext instance for chaining

sendActivities

• sendActivities(activities: Activity[]): Promise<ResourceResponse[]>

  Sends multiple activities to the sender of the incoming activity.

  Parameters

  • activities: Activity[]

    The array of activities to send

  Returns Promise<ResourceResponse[]>

  A promise that resolves to an array of resource responses

  Remarks

  This method applies conversation references to each activity and emits them through the middleware chain before sending them to the adapter.

sendActivity

• sendActivity(
      activityOrText: string | Activity,
      speak?: string,
      inputHint?: string,
  ): Promise<ResourceResponse | undefined>

  Sends an activity to the sender of the incoming activity.

  Parameters

  • activityOrText: string | Activity

    The activity to send or a string for a simple message

  • Optionalspeak: string

    Optional text to be spoken by the agent

  • OptionalinputHint: string

    Optional input hint to indicate if the agent is expecting input

  Returns Promise<ResourceResponse | undefined>

  A promise that resolves to the resource response or undefined

  Remarks

  This is the primary method used to respond to the user. It automatically addresses the response to the correct conversation and recipient using information from the incoming activity.

sendTraceActivity

• sendTraceActivity(
      name: string,
      value?: any,
      valueType?: string,
      label?: string,
  ): Promise<ResourceResponse | undefined>

  Sends a trace activity for debugging purposes.

  Parameters

  • name: string

    The name/category of the trace

  • Optionalvalue: any

    The value/data to include in the trace

  • OptionalvalueType: string

    Optional type name for the value

  • Optionallabel: string

    Optional descriptive label for the trace

  Returns Promise<ResourceResponse | undefined>

  A promise that resolves to the resource response or undefined

  Remarks

  Trace activities are typically used for debugging and are only visible in channels that support them, like the Bot Framework Emulator.

updateActivity

• updateActivity(activity: Activity): Promise<void>

  Updates an existing activity in the conversation.

  Parameters

  • activity: Activity

    The activity to update with its ID specified

  Returns Promise<void>

  A promise that resolves when the activity has been updated

  Remarks

  This can be used to edit previously sent activities, for example to update the content of an adaptive card or change a message.

uploadAttachment

• uploadAttachment(
      conversationId: string,
      attachmentData: AttachmentData,
  ): Promise<ResourceResponse>

  Parameters

  • conversationId: string

    The ID of the conversation

  • attachmentData: AttachmentData

    The attachment data to upload

  Returns Promise<ResourceResponse>

  A promise that resolves to the resource response

  Deprecated

  This function will not be supported in future versions. Use TurnContext.turnState.get(CloudAdapter.ConnectorClientKey). Uploads an attachment to the conversation.