Class TurnStateImplInternal

constructor

• new TurnStateImpl(
      storage: Storage,
      conversationKey: string,
      userKey: string,
      conversationData: Record<string, unknown>,
      userData: Record<string, unknown>,
  ): TurnStateImpl

  Parameters

  • storage: Storage
  • conversationKey: string
  • userKey: string
  • conversationData: Record<string, unknown>
  • userData: Record<string, unknown>

  Returns TurnStateImpl

Readonlyconversation

Readonlyuser

Readonlytemp

getValue

• getValue<T = unknown>(path: string): T | undefined

  Get a value by path. Path format: "[scope].property" or "property" (defaults to temp).

  Type Parameters

  • T = unknown

  Parameters

  • path: string

  Returns T | undefined

  Example

  ctx.state?.getValue<number>('conversation.count')
  ctx.state?.getValue<string>('input')  // defaults to temp scope
  Copy

setValue

• setValue<T>(path: string, value: T): void

  Set a value by path. Path format: "[scope].property" or "property" (defaults to temp).

  Type Parameters

  • T

  Parameters

  • path: string
  • value: T

  Returns void

  Example

  ctx.state?.setValue('conversation.count', 42)
  ctx.state?.setValue('input', 'hello')  // defaults to temp scope
  Copy

hasValue

• hasValue(path: string): boolean

  Check if a value exists at path.

  Parameters

  • path: string

  Returns boolean

  Example

  if (ctx.state?.hasValue('conversation.count')) { ... }
  Copy

deleteValue

• deleteValue(path: string): void

  Delete a value at path.

  Parameters

  • path: string

  Returns void

  Example

  ctx.state?.deleteValue('conversation.count')
  Copy

deleteConversationState

• deleteConversationState(): void

  Delete all state in the conversation scope.

  Returns void

deleteUserState

• deleteUserState(): void

  Delete all state in the user scope.

  Returns void

deleteTempState

• deleteTempState(): void

  Delete all state in the temp scope.

  Returns void

saveAsync

• saveAsync(): Promise<void>
  Internal

  Save dirty state to storage. Only writes scopes that have changed since load.

  Returns Promise<void>

StaticloadAsync

• loadAsync(storage: Storage, activity: CoreActivity): Promise<TurnStateImpl>
  Internal

  Create a TurnState from an activity by deriving storage keys.

  Parameters

  • storage: Storage
  • activity: CoreActivity

  Returns Promise<TurnStateImpl>