다음을 통해 공유


StatePropertyAccessor interface

BotState 개체에서 만든 상태 속성에 액세스하기 위한 메서드를 정의합니다.

설명

상태 관리 objet에서 상태 속성을 만들려면 createProperty<T> 메서드를 사용합니다.

메서드

delete(TurnContext)

백업 스토리지 개체에서 지속형 속성을 삭제합니다.

get(TurnContext)

백업 스토리지 개체에서 지속형 속성을 읽습니다.

get(TurnContext, T)
set(TurnContext, T)

스토리지 개체를 지원하는 속성에 새 값을 할당합니다.

메서드 세부 정보

delete(TurnContext)

백업 스토리지 개체에서 지속형 속성을 삭제합니다.

function delete(context: TurnContext): Promise<void>

매개 변수

context
TurnContext

사용자와의 현재 대화 전환에 대한 컨텍스트입니다.

반환

Promise<void>

설명

스토리지 개체를 지원하는 속성은 첫 번째 액세스에서 메모리에 로드되어야 합니다.

await myProperty.delete(context);

get(TurnContext)

백업 스토리지 개체에서 지속형 속성을 읽습니다.

function get(context: TurnContext): Promise<T | undefined>

매개 변수

context
TurnContext

사용자와의 현재 대화 전환에 대한 컨텍스트입니다.

반환

Promise<T | undefined>

설명

스토리지 개체를 지원하는 속성은 첫 번째 액세스에서 메모리에 로드되어야 합니다.

현재 스토리지 개체에 속성이 없으며 defaultValue 지정한 경우 defaultValue 복제본을 스토리지 개체에 복사해야 합니다. defaultValue 지정되지 않은 경우 undefined 값이 반환되어야 합니다.

const value = await myProperty.get(context, { count: 0 });

get(TurnContext, T)

function get(context: TurnContext, defaultValue: T): Promise<T>

매개 변수

context
TurnContext
defaultValue

T

반환

Promise<T>

set(TurnContext, T)

스토리지 개체를 지원하는 속성에 새 값을 할당합니다.

function set(context: TurnContext, value: T): Promise<void>

매개 변수

context
TurnContext

사용자와의 현재 대화 전환에 대한 컨텍스트입니다.

value

T

할당할 값입니다.

반환

Promise<void>

설명

스토리지 개체를 지원하는 속성은 첫 번째 액세스에서 메모리에 로드되어야 합니다.

상태 시스템 구현에 따라 디스크의 실제 변경 내용을 유지하기 위해 추가 단계가 필요할 수 있습니다.

await myProperty.set(context, value);