Share via

TurnStateEntry class

  • Reference
Package:
@microsoft/teams-ai

Accessor class for managing an individual state scope.

Constructors

TurnStateEntry(Record<string, unknown>, string)

Creates a new instance of the TurnStateEntry class.

Properties

hasChanged

Gets a value indicating whether the state scope has changed since it was last loaded.
isDeleted

Gets a value indicating whether the state scope has been deleted.
storageKey

Gets the storage key used to persist the state scope.
value

Gets the value of the state scope.

Methods

delete()

Clears the state scope.
replace(Record<string, unknown>)

Replaces the state scope with a new value.

Constructor Details

TurnStateEntry(Record<string, unknown>, string)

Creates a new instance of the TurnStateEntry class.

new TurnStateEntry(value?: Record<string, unknown>, storageKey?: string)

Parameters

value

Record<string, unknown>

Optional. Value to initialize the state scope with. The default is an {} object.

storageKey

string

Optional. Storage key to use when persisting the state scope.

Property Details

hasChanged

Gets a value indicating whether the state scope has changed since it was last loaded.

boolean hasChanged

Property Value

boolean

A value indicating whether the state scope has changed.

isDeleted

Gets a value indicating whether the state scope has been deleted.

boolean isDeleted

Property Value

boolean

A value indicating whether the state scope has been deleted.

storageKey

Gets the storage key used to persist the state scope.

undefined | string storageKey

Property Value

undefined | string

The storage key used to persist the state scope.

value

Gets the value of the state scope.

Record<string, unknown> value

Property Value

Record<string, unknown>

value of the state scope.

Method Details

delete()

Clears the state scope.

function delete()

replace(Record<string, unknown>)

Replaces the state scope with a new value.

function replace(value?: Record<string, unknown>)

Parameters

value

Record<string, unknown>

New value to replace the state scope with.