Microsoft.Bot.Builder.Dialogs.Internals.IDialogTask Interface Reference
Inheritance diagram for Microsoft.Bot.Builder.Dialogs.Internals.IDialogTask:

Public Member Functions

void Call< R > (IDialog< R > child, ResumeAfter< R > resume)
 Call a child dialog and add it to the top of the stack. More...
 
void Done< R > (R value)
 Complete the current dialog and return a result to the parent dialog. More...
 
void Fail (Exception error)
 Fail the current dialog and return an exception to the parent dialog. More...
 
Task Forward< R, T > (IDialog< R > child, ResumeAfter< R > resume, T item, CancellationToken token)
 Call a child dialog, add it to the top of the stack and post the item to the child dialog. More...
 
Task PollAsync (CancellationToken token)
 Poll the target for any work to be done. More...
 
void Post (Event @event, Action onPull=null)
 
void Post< E > (E @event, ResumeAfter< E > resume)
 Post an internal event to the queue. More...
 
void Reset ()
 Resets the stack. More...
 
void Wait< R > (ResumeAfter< R > resume)
 Suspend the current dialog until an external event has been sent to the bot. More...
 

Properties

IReadOnlyList< Delegate > Frames [get]
 The dialog frames active on the stack. More...
 

Detailed Description

Definition at line 105 of file IDialogTask.cs.

Member Function Documentation

void Microsoft.Bot.Builder.Dialogs.Internals.IDialogStack.Call< R > ( IDialog< R >  child,
ResumeAfter< R >  resume 
)
inherited

Call a child dialog and add it to the top of the stack.

Template Parameters
RThe type of result expected from the child dialog.
Parameters
childThe child dialog.
resumeThe method to resume when the child dialog has completed.
void Microsoft.Bot.Builder.Dialogs.Internals.IDialogStack.Done< R > ( value)
inherited

Complete the current dialog and return a result to the parent dialog.

Template Parameters
RThe type of the result dialog.
Parameters
valueThe value of the result.
void Microsoft.Bot.Builder.Dialogs.Internals.IDialogStack.Fail ( Exception  error)
inherited

Fail the current dialog and return an exception to the parent dialog.

Parameters
errorThe error.
Task Microsoft.Bot.Builder.Dialogs.Internals.IDialogStack.Forward< R, T > ( IDialog< R >  child,
ResumeAfter< R >  resume,
item,
CancellationToken  token 
)
inherited

Call a child dialog, add it to the top of the stack and post the item to the child dialog.

Template Parameters
RThe type of result expected from the child dialog.
TThe type of the item posted to child dialog.
Parameters
childThe child dialog.
resumeThe method to resume when the child dialog has completed.
itemThe item that will be posted to child dialog.
tokenA cancellation token.
Returns
A task representing the Forward operation.
Task Microsoft.Bot.Builder.Base.IEventLoop.PollAsync ( CancellationToken  token)
inherited

Poll the target for any work to be done.

Parameters
tokenA cancellation token.
Returns
A task representing the poll operation.
void Microsoft.Bot.Builder.Base.IEventProducer< in in Event >.Post ( Event @  event,
Action  onPull = null 
)
inherited
void Microsoft.Bot.Builder.Dialogs.Internals.IDialogStack.Post< E > ( E @  event,
ResumeAfter< E >  resume 
)
inherited

Post an internal event to the queue.

Parameters
eventThe event to post to the queue.
resumeThe method to resume when the event has been delivered.
void Microsoft.Bot.Builder.Dialogs.Internals.IDialogStack.Reset ( )
inherited

Resets the stack.

void Microsoft.Bot.Builder.Dialogs.Internals.IDialogStack.Wait< R > ( ResumeAfter< R >  resume)
inherited

Suspend the current dialog until an external event has been sent to the bot.

Parameters
resumeThe method to resume when the event has been received.

Property Documentation

IReadOnlyList<Delegate> Microsoft.Bot.Builder.Dialogs.Internals.IDialogStack.Frames
getinherited

The dialog frames active on the stack.

Definition at line 51 of file IDialogTask.cs.


The documentation for this interface was generated from the following file: