SkillDialog Класс

  • Ссылка
Пакет:
com.microsoft.bot.dialogs
Артефакт Maven:
com.microsoft.bot:bot-dialogs:4.14.3

public class SkillDialog
extends Dialog

Специализированный Dialog, который может упаковывать удаленные вызовы к навыку. Параметр параметров в BeginDialog должен быть BeginSkillDialogOptions экземпляром с начальными параметрами диалогового окна.

Сводка по конструктору

Конструктор Описание
SkillDialog(SkillDialogOptions dialogOptions, String dialogId)

Инициализирует новый экземпляр класса SkillDialog для переноса удаленных вызовов к навыку.

Сводка по методу

Модификатор и тип Метод и описание
java.util.concurrent.CompletableFuture<DialogTurnResult> beginDialog(DialogContext dc, Object options)

Вызывается при запуске диалогового окна навыка и отправке в стек диалогов.
java.util.concurrent.CompletableFuture<DialogTurnResult> continueDialog(DialogContext dc)

Вызывается при выполнении диалогового окна навыка _continued_, где он является активным диалогом, а пользователь отвечает с новым действием.
java.util.concurrent.CompletableFuture<java.lang.Void> endDialog(TurnContext turnContext, DialogInstance instance, DialogReason reason)

Вызывается, когда заканчивается диалоговое окно навыка.
protected SkillDialogOptions getDialogOptions()

Возвращает параметры, используемые для выполнения диалогового окна навыка.
protected boolean onValidateActivity(Activity activity)

Проверяет действие, отправленное во время диалогового окна "Продолжить".
java.util.concurrent.CompletableFuture<java.lang.Void> repromptDialog(TurnContext turnContext, DialogInstance instance)

Вызывается, когда диалоговое окно навыка должно повторно запрашивать ввод пользователем.
java.util.concurrent.CompletableFuture<DialogTurnResult> resumeDialog(DialogContext dc, DialogReason reason, Object result)

Вызывается, когда диалоговое окно дочернего навыка завершило свою очередь, возвращая элемент управления в это диалоговое окно.

Методы, унаследованные от Dialog

beginDialog beginDialog continueDialog endDialog getId getTelemetryClient getVersion innerRun onComputeId onDialogEvent onPostBubbleEvent onPreBubbleEvent repromptDialog resumeDialog resumeDialog run setId setTelemetryClient

Методы, унаследованные от 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

Сведения о конструкторе

SkillDialog

public SkillDialog(SkillDialogOptions dialogOptions, String dialogId)

Инициализирует новый экземпляр класса SkillDialog для переноса удаленных вызовов к навыку.

Параметры:

dialogOptions - Параметры для выполнения диалогового окна навыка.
dialogId - Идентификатор диалогового окна.

Сведения о методе

beginDialog

public CompletableFuture beginDialog(DialogContext dc, Object options)

Вызывается при запуске диалогового окна навыка и отправке в стек диалогов.

Переопределения:

SkillDialog.beginDialog(DialogContext dc, Object options)

Параметры:

dc - DialogContext для текущего поворота беседы.
options - Необязательные, начальные сведения для передачи в диалоговое окно.

Возвращаемое значение:

CompletableFuture, представляющий асинхронную операцию. 
     If the task is successful, the result indicates whether the dialog is
     still active after the turn has been processed by the dialog.

continueDialog

public CompletableFuture continueDialog(DialogContext dc)

Вызывается при выполнении диалогового окна навыка _continued_, где он является активным диалогом, а пользователь отвечает с новым действием.

Переопределения:

SkillDialog.continueDialog(DialogContext dc)

Параметры:

dc - DialogContext для текущего поворота беседы.

Возвращаемое значение:

CompletableFuture, представляющий асинхронную операцию. 
     If the task is successful, the result indicates whether the dialog is
     still active after the turn has been processed by the dialog. The
     result may also contain a return value.

endDialog

public CompletableFuture endDialog(TurnContext turnContext, DialogInstance instance, DialogReason reason)

Вызывается, когда заканчивается диалоговое окно навыка.

Переопределения:

SkillDialog.endDialog(TurnContext turnContext, DialogInstance instance, DialogReason reason)

Параметры:

turnContext - Объект контекста для этого шага.
instance - Сведения о состоянии, связанные с экземпляром этого диалогового окна в стеке диалогов.
reason - Причина, по которой диалоговое окно закончилось.

Возвращаемое значение:

CompletableFuture, представляющий асинхронную операцию.

getDialogOptions

protected SkillDialogOptions getDialogOptions()

Возвращает параметры, используемые для выполнения диалогового окна навыка.

Возвращаемое значение:

Значение DialogOptions в виде SkillDialogOptions.

onValidateActivity

protected boolean onValidateActivity(Activity activity)

Проверяет действие, отправленное во время ContinueDialog.

Параметры:

activity - Activity для текущего поворота беседы. 
             Override this method to implement a custom validator for the
             activity being sent during the ContinueDialog . This
             method can be used to ignore activities of a certain type if
             needed. If this method returns false, the dialog will end the
             turn without processing the activity.

Возвращаемое значение:

Значение true, если действие допустимо, значение false, если нет.

repromptDialog

public CompletableFuture repromptDialog(TurnContext turnContext, DialogInstance instance)

Вызывается, когда диалоговое окно навыка должно повторно запрашивать ввод пользователем.

Переопределения:

SkillDialog.repromptDialog(TurnContext turnContext, DialogInstance instance)

Параметры:

turnContext - Объект контекста для этого шага.
instance - Сведения о состоянии этого диалогового окна.

Возвращаемое значение:

CompletableFuture, представляющий асинхронную операцию.

resumeDialog

public CompletableFuture resumeDialog(DialogContext dc, DialogReason reason, Object result)

Вызывается, когда диалоговое окно дочернего навыка завершило свою очередь, возвращая элемент управления в это диалоговое окно.

Переопределения:

SkillDialog.resumeDialog(DialogContext dc, DialogReason reason, Object result)

Параметры:

dc - Контекст диалогового окна для текущей очереди беседы.
reason - Причина возобновления диалога.
result - Необязательное значение, возвращаемое из вызываемого диалогового окна. Тип возвращаемого значения зависит от дочернего диалогового окна.

Возвращаемое значение:

CompletableFuture, представляющий асинхронную операцию.

Применяется к