DialogContext 類別
- java.
lang. Object - com.
microsoft. bot. dialogs. DialogContext
- com.
public class DialogContext
提供對話框堆疊目前狀態的內容。
建構函式摘要
| 建構函式 | Description |
|---|---|
| DialogContext(DialogSet withDialogs, TurnContext withTurnContext, DialogState withState) |
從回合內容初始化 Dialog |
| DialogContext(DialogSet withDialogs, DialogContext withParentDialogContext, DialogState withState) |
從回合內容初始化 Dialog |
方法摘要
| 修飾詞與類型 | 方法與描述 |
|---|---|
|
java.util.concurrent.CompletableFuture<Dialog |
beginDialog(String dialogId)
啟動新的對話框,並將其推送至對話堆疊。 |
|
java.util.concurrent.CompletableFuture<Dialog |
beginDialog(String dialogId, Object options)
啟動新的對話框,並將其推送至對話堆疊。 |
|
java.util.concurrent.CompletableFuture<Dialog |
cancelAllDialogs()
不會取消父對話或傳遞 和事件的 cancelAllDialogs(boolean cancelParents, String eventName, Object eventValue) 協助程式方法。 |
|
java.util.concurrent.CompletableFuture<Dialog |
cancelAllDialogs(boolean cancelParents, String eventName, Object eventValue)
刪除任何現有的對話堆疊,因此會取消堆疊上的所有對話方塊。 |
|
java.util.concurrent.CompletableFuture<Dialog |
continueDialog()
如果有的話,繼續執行使用中的對話框,方法是將目前的 Dialog |
| java.util.concurrent.CompletableFuture<java.lang.Boolean> | emitEvent(String name) |
| java.util.concurrent.CompletableFuture<java.lang.Boolean> | emitEvent(String name, Object value, boolean bubble, boolean fromLeaf) |
|
java.util.concurrent.CompletableFuture<Dialog |
endDialog()
提供 null 結果給 endDialog(Object result)的協助程式方法。 |
|
java.util.concurrent.CompletableFuture<Dialog |
endDialog(Object result)
結束對話的方式是將對話框從堆疊中彈出,並將選擇性結果傳回給對話框的父代。 |
| Dialog |
findDialog(String dialogId)
尋找指定內容的對話框識別碼。 |
|
Dialog |
getActiveDialog()
取得堆疊頂端作用中對話框的快取實例,如果堆疊是空的,則為 Null。 |
|
Dialog |
getChild()
如果有作用中的子系,則取得子系的對話內容。 |
|
Turn |
getContext()
取得目前交談回合的內容。 |
|
Dialog |
getDialogs()
取得目前對話容器作用中的對話框集合。 |
| java.lang.String |
getLocale()
取得 Dialog |
|
Dialog |
getParent()
取得內容 |
|
Turn |
getServices()
取得與這個對話內容相關的服務集合。 |
|
java.util.List<Dialog |
getStack()
取得目前的對話框堆疊。 |
|
Dialog |
getState()
取得或設定管理所有記憶體範圍檢視的 Dialog |
|
java.util.concurrent.CompletableFuture<Dialog |
prompt(String dialogId, PromptOptions options)
協助程式函式可簡化呼叫提示對話框之選項的格式設定。 |
|
java.util.concurrent.CompletableFuture<Dialog |
replaceDialog(String dialogId)
傳遞選項之 replaceDialog(String dialogId, Object options) 的 Helper 方法。 |
|
java.util.concurrent.CompletableFuture<Dialog |
replaceDialog(String dialogId, Object options)
啟動新的對話框,並以新的對話框取代目前使用中的對話框堆棧。 |
| java.util.concurrent.CompletableFuture<java.lang.Void> |
repromptDialog()
呼叫目前使用中對話框的 repromptDialog(TurnContext turnContext, DialogInstance instance) 方法。 |
| void |
setParent(DialogContext withDialogContext)
設定內容 |
方法繼承來源 java.lang.Object
建構函式詳細資料
DialogContext
public DialogContext(DialogSet withDialogs, TurnContext withTurnContext, DialogState withState)
從回合內容初始化 DialogContext 類別的新實例。
參數:
DialogContext
public DialogContext(DialogSet withDialogs, DialogContext withParentDialogContext, DialogState withState)
從回合內容初始化 DialogContext 類別的新實例。
參數:
方法詳細資料
beginDialog
public CompletableFuture
啟動新的對話框,並將其推送至對話堆疊。
參數:
傳回:
beginDialog
public CompletableFuture
啟動新的對話框,並將其推送至對話堆疊。
參數:
傳回:
cancelAllDialogs
public CompletableFuture
不會取消父對話或傳遞 和事件的 cancelAllDialogs(boolean cancelParents, String eventName, Object eventValue) 協助程式方法。
傳回:
cancelAllDialogs
public CompletableFuture
刪除任何現有的對話堆疊,因此會取消堆疊上的所有對話方塊。
一般而言,父內容是啟動對話框的對話框或 Bot 回合處理程式。 如果父代是對話框,堆疊會呼叫父系的 resumeDialog(DialogContext dc, DialogReason reason, Object result) 方法,將結果傳回父對話。 如果父對話框未實作 Dialog#resumeDialog,則父代也會結束,並將結果傳遞至下一個父內容。
參數:
傳回:
continueDialog
public CompletableFuture
如果有的話,繼續執行使用中的對話框,方法是將目前的 DialogContext 傳遞至使用中對話的 continueDialog(DialogContext dc) 方法。
傳回:
emitEvent
public CompletableFuture
參數:
傳回:
emitEvent
public CompletableFuture
參數:
true的值。
傳回:
endDialog
public CompletableFuture
提供 null 結果給 endDialog(Object result)的協助程式方法。
傳回:
endDialog
public CompletableFuture
結束對話的方式是將對話框從堆疊中彈出,並將選擇性結果傳回給對話框的父代。 父對話是透過呼叫 beginDialog(String dialogId, Object options) 或 prompt(String dialogId, PromptOptions options)結束的 對話框。 父對話框會使用任何傳回的結果叫用其 resumeDialog(DialogContext dc, DialogReason reason, Object result) 方法。 如果父對話框尚未實作 resumeDialog(DialogContext dc, DialogReason reason) 方法,則它也會自動結束,並將結果傳遞至其父系。 如果堆疊上沒有更多父對話框,回合的處理將會結束。
參數:
傳回:
findDialog
public Dialog findDialog(String dialogId)
尋找指定內容的對話框識別碼。
參數:
傳回:
getActiveDialog
public DialogInstance getActiveDialog()
取得堆疊頂端作用中對話框的快取實例,如果堆疊是空的,則為 Null。
傳回:
getChild
public DialogContext getChild()
如果有作用中的子系,則取得子系的對話內容。
傳回:
getContext
public TurnContext getContext()
取得目前交談回合的內容。
傳回:
getDialogs
public DialogSet getDialogs()
取得目前對話容器作用中的對話框集合。
傳回:
getLocale
public String getLocale()
在 DialogContext 中取得地區設定。
傳回:
getParent
public DialogContext getParent()
取得父 DialogContext,如果有的話。 用於搜尋要啟動之對話框的標識碼。
傳回:
getServices
public TurnContextStateCollection getServices()
取得與這個對話內容相關的服務集合。
傳回:
getStack
public List
取得目前的對話框堆疊。
傳回:
getState
public DialogStateManager getState()
取得或設定 DialogStateManager,可管理所有記憶體範圍的檢視。
傳回:
prompt
public CompletableFuture
協助程式函式可簡化呼叫提示對話框之選項的格式設定。 此協助程式會採用 PromptOptions 自變數,然後呼叫 beginDialog(String dialogId, Object options)
參數:
傳回:
replaceDialog
public CompletableFuture
傳遞選項之 replaceDialog(String dialogId, Object options) 的 Helper 方法。
參數:
傳回:
replaceDialog
public CompletableFuture
啟動新的對話框,並以新的對話框取代目前使用中的對話框堆棧。 這對於建立迴圈或重新導向至另一個對話框特別有用。
參數:
傳回:
repromptDialog
public CompletableFuture
呼叫目前使用中對話框的 repromptDialog(TurnContext turnContext, DialogInstance instance) 方法。 與實作重新提示行為的對話框搭配使用。
傳回:
setParent
public void setParent(DialogContext withDialogContext)
設定父 DialogContext。
參數: