你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
IDurableOrchestrationContext.WaitForExternalEvent 方法
定义
重要
一些信息与预发行产品相关，相应产品在发行之前可能会进行重大修改。 对于此处提供的信息，Microsoft 不作任何明示或暗示的担保。
重载
| WaitForExternalEvent(String) |
异步等待事件被引发，名称 |
| WaitForExternalEvent(String, TimeSpan, CancellationToken) |
异步等待事件被引发，名称 |
| WaitForExternalEvent<T>(String, TimeSpan, CancellationToken) |
异步等待事件以名称 |
| WaitForExternalEvent<T>(String) |
异步等待事件以名称 |
| WaitForExternalEvent<T>(String, TimeSpan, T, CancellationToken) |
异步等待事件以名称 |
WaitForExternalEvent(String)
异步等待事件被引发，名称 name为 。
public System.Threading.Tasks.Task WaitForExternalEvent (string name);abstract member WaitForExternalEvent : string -> System.Threading.Tasks.TaskPublic Function WaitForExternalEvent (name As String) As Task参数
- name
- String
要等待的事件的名称。
返回
在收到外部事件时完成的持久任务。
注解
外部客户端可以使用 将对象参数设置为 null的 将事件引发到等待的业务流程实例RaiseEventAsync(String, String, Object)。
适用于
WaitForExternalEvent(String, TimeSpan, CancellationToken)
异步等待事件被引发，名称 name为 。
public System.Threading.Tasks.Task WaitForExternalEvent (string name, TimeSpan timeout, System.Threading.CancellationToken cancelToken = default);abstract member WaitForExternalEvent : string * TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.TaskPublic Function WaitForExternalEvent (name As String, timeout As TimeSpan, Optional cancelToken As CancellationToken = Nothing) As Task参数
- name
- String
要等待的事件的名称。
- timeout
- TimeSpan
要在此之后引发 TimeoutException 的持续时间。
- cancelToken
- CancellationToken
CancellationToken要用于取消 timeout的内部计时器的 。
返回
在收到外部事件时完成的持久任务。
例外
在超时到期之前未收到外部事件。
注解
外部客户端可以使用 将对象参数设置为 null的 将事件引发到等待的业务流程实例RaiseEventAsync(String, String, Object)。
适用于
WaitForExternalEvent<T>(String, TimeSpan, CancellationToken)
异步等待事件以名称 name 引发，并返回事件数据。
public System.Threading.Tasks.Task<T> WaitForExternalEvent<T> (string name, TimeSpan timeout, System.Threading.CancellationToken cancelToken = default);abstract member WaitForExternalEvent : string * TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task<'T>Public Function WaitForExternalEvent(Of T) (name As String, timeout As TimeSpan, Optional cancelToken As CancellationToken = Nothing) As Task(Of T)类型参数
- T
表示 JSON 事件有效负载的任何可序列化类型。
参数
- name
- String
要等待的事件的名称。
- timeout
- TimeSpan
等待事件的持续时间。
- cancelToken
- CancellationToken
CancellationToken要用于取消 timeout的内部计时器的 。
返回
在收到外部事件时完成的持久任务，或者如果超时过期，则引发超时异常> 。
例外
在超时到期之前未收到外部事件。
注解
外部客户端可以使用 将事件引发到等待的 RaiseEventAsync(String, String, Object)业务流程实例。
适用于
WaitForExternalEvent<T>(String)
异步等待事件以名称 name 引发，并返回事件数据。
public System.Threading.Tasks.Task<T> WaitForExternalEvent<T> (string name);abstract member WaitForExternalEvent : string -> System.Threading.Tasks.Task<'T>Public Function WaitForExternalEvent(Of T) (name As String) As Task(Of T)类型参数
- T
表示 JSON 事件有效负载的任何可序列化类型。
参数
- name
- String
要等待的事件的名称。
返回
在收到外部事件时完成的持久任务。
注解
外部客户端可以使用 将事件引发到等待的 RaiseEventAsync(String, String, Object)业务流程实例。
适用于
WaitForExternalEvent<T>(String, TimeSpan, T, CancellationToken)
异步等待事件以名称 name 引发，并返回事件数据。
public System.Threading.Tasks.Task<T> WaitForExternalEvent<T> (string name, TimeSpan timeout, T defaultValue, System.Threading.CancellationToken cancelToken = default);abstract member WaitForExternalEvent : string * TimeSpan * 'T * System.Threading.CancellationToken -> System.Threading.Tasks.Task<'T>Public Function WaitForExternalEvent(Of T) (name As String, timeout As TimeSpan, defaultValue As T, Optional cancelToken As CancellationToken = Nothing) As Task(Of T)类型参数
- T
表示 JSON 事件有效负载的任何可序列化类型。
参数
- name
- String
要等待的事件的名称。
- timeout
- TimeSpan
等待事件的持续时间。
- defaultValue
- T
如果指定，则为在收到外部事件之前超时到期时返回的默认值。 否则，将改为引发超时异常。
- cancelToken
- CancellationToken
CancellationToken要用于取消 timeout的内部计时器的 。
返回
在收到外部事件时完成的持久任务;如果超时过期，则返回 的值 defaultValue 。
注解
外部客户端可以使用 将事件引发到等待的 RaiseEventAsync(String, String, Object)业务流程实例。
