DialogSet 類別

  • java.lang.Object
    • com.microsoft.bot.dialogs.DialogSet

public class DialogSet

可彼此呼叫的 Dialog 物件的集合。

建構函式摘要

建構函式 Description
DialogSet()

建立對話框設定沒有狀態。

DialogSet(StatePropertyAccessor<DialogState> withDialogState)

初始化 DialogSet 類別的新實例。

方法摘要

修飾詞與類型 方法與描述
DialogSet add(Dialog dialog)

將新的對話框新增至集合,並傳回集合以允許 Fluent 鏈結。

java.util.concurrent.CompletableFuture<DialogContext> createContext(TurnContext turnContext)

建立對話框內容,可用來處理對話框集中的對話框。

Dialog find(String dialogId)

搜尋目前的對話框依其標識碼設定對話方塊。

java.util.Collection<Dialog> getDialogs()

傳回此 DialogSet 中的 Dialogs 集合。

BotTelemetryClient getTelemetryClient()

取得要用於記錄的 Bot遙測用戶端。

java.lang.String getVersion()

取得唯一的字串,表示這個對話框集中所有對話框的合併版本。

void setTelemetryClient(BotTelemetryClient withBotTelemetryClient)

將 Bot遙測客戶端設定為用於記錄。

方法繼承來源 java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

建構函式詳細資料

DialogSet

public DialogSet()

建立沒有狀態的 DialogSet。

DialogSet

public DialogSet(StatePropertyAccessor withDialogState)

初始化 DialogSet 類別的新實例。

若要啟動及控制此對話集中的對話,請建立 DialogContext,並使用其方法來啟動、繼續或結束對話。 若要建立對話內容,請呼叫 createContext(TurnContext)。

參數:

withDialogState - 用來管理這個對話框集堆疊的狀態屬性存取子。

方法詳細資料

add

public DialogSet add(Dialog dialog)

將新的對話框新增至集合,並傳回集合以允許 Fluent 鏈結。 如果 Dialog.Id 已存在於集合中,對話標識符將會更新為包含後綴,使其是唯一的。 因此,將名為 「duplicate」 的 2 個對話框新增至集合會導致第一個對話方塊具有 「duplicate」 的標識碼,而第二個對話框的標識碼為 「duplicate2」。。

參數:

dialog - 要新增的對話框。 新增對話框的 Dialog.TelemetryClient 會設定為對話框集的 BotTelemetryClient。

傳回:

作業完成之後所設定的對話框。

createContext

public CompletableFuture createContext(TurnContext turnContext)

建立 DialogContext,可用來處理 DialogSet 中的對話方塊。

參數:

turnContext - 目前與使用者交談回合的內容。

傳回:

代表異步作的 CompletableFuture。

find

public Dialog find(String dialogId)

依其標識子搜尋目前 DialogSet 中的對話方塊。

參數:

dialogId - 要搜尋之對話框的標識碼。

傳回:

如果找到對話框,則為 ;否則為 null

getDialogs

public Collection

getDialogs()

傳回這個 DialogSet 中的 Dialogs 集合。

傳回:

此 DialogSet 中的對話框。

getTelemetryClient

public BotTelemetryClient getTelemetryClient()

取得要用於記錄的 BotTelemetryClient。

傳回:

要用於記錄的 BotTelemetryClient。

getVersion

public String getVersion()

取得唯一的字串,表示這個對話框集中所有對話框的合併版本。

傳回:

當任何子對話版本變更時,版本將會變更。

setTelemetryClient

public void setTelemetryClient(BotTelemetryClient withBotTelemetryClient)

設定要用於記錄的 BotTelemetryClient。

設定此屬性時,它會將集合中每個對話框的 Dialog.TelemetryClient 設定為新值。

參數:

withBotTelemetryClient - 要用於記錄的 BotTelemetryClient。

適用於