ConversationReferenceStore interface

Package:

@microsoft/teamsfx

A store to persist notification target references.

Methods

add(string, Partial<ConversationReference>, ConversationReferenceStoreAddOptions)	Add a conversation reference to the store. If overwrite, update existing one, otherwise add when not exist.
list(number, string)	List stored conversation reference by page.
remove(string, Partial<ConversationReference>)	Remove a conversation reference from the store.

Method Details

add(string, Partial<ConversationReference>, ConversationReferenceStoreAddOptions)

Add a conversation reference to the store. If overwrite, update existing one, otherwise add when not exist.

function add(key: string, reference: Partial<ConversationReference>, options: ConversationReferenceStoreAddOptions): Promise<boolean>

Parameters

key

string

the key of the conversation reference.

reference

Partial<ConversationReference>

the conversation reference to add.

options

ConversationReferenceStoreAddOptions

the options to add the conversation reference.

Returns

Promise<boolean>

true if added or updated, false if not changed.

list(number, string)

List stored conversation reference by page.

function list(pageSize?: number, continuationToken?: string): Promise<PagedData<Partial<ConversationReference>>>

Parameters

pageSize

number

the page size.

continuationToken

string

the continuation token to get next page.

Returns

Promise<PagedData<Partial<ConversationReference>>>

a paged list of conversation references.

remove(string, Partial<ConversationReference>)

Remove a conversation reference from the store.

function remove(key: string, reference: Partial<ConversationReference>): Promise<boolean>

Parameters

key

string

the key of the conversation reference.

reference

Partial<ConversationReference>

the conversation reference to remove.

Returns

Promise<boolean>

true if exist and removed, false if not changed.