/
DispatcherQueueExtensions.xml
160 lines (160 loc) · 13.3 KB
/
DispatcherQueueExtensions.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
<Type Name="DispatcherQueueExtensions" FullName="Microsoft.Toolkit.Uwp.DispatcherQueueExtensions">
<TypeSignature Language="C#" Value="public static class DispatcherQueueExtensions" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract sealed beforefieldinit DispatcherQueueExtensions extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Toolkit.Uwp.DispatcherQueueExtensions" />
<TypeSignature Language="VB.NET" Value="Public Module DispatcherQueueExtensions" />
<TypeSignature Language="F#" Value="type DispatcherQueueExtensions = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.Toolkit.Uwp</AssemblyName>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>7.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Helpers for executing code in a <see cref="T:Windows.System.DispatcherQueue" />.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="EnqueueAsync">
<MemberSignature Language="C#" Value="public static System.Threading.Tasks.Task EnqueueAsync (this Windows.System.DispatcherQueue dispatcher, Action function, Windows.System.DispatcherQueuePriority priority = Windows.System.DispatcherQueuePriority.Normal);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Threading.Tasks.Task EnqueueAsync(class Windows.System.DispatcherQueue dispatcher, class System.Action function, valuetype Windows.System.DispatcherQueuePriority priority) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Toolkit.Uwp.DispatcherQueueExtensions.EnqueueAsync(Windows.System.DispatcherQueue,System.Action,Windows.System.DispatcherQueuePriority)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function EnqueueAsync (dispatcher As DispatcherQueue, function As Action, Optional priority As DispatcherQueuePriority = Windows.System.DispatcherQueuePriority.Normal) As Task" />
<MemberSignature Language="F#" Value="static member EnqueueAsync : Windows.System.DispatcherQueue * Action * Windows.System.DispatcherQueuePriority -> System.Threading.Tasks.Task" Usage="Microsoft.Toolkit.Uwp.DispatcherQueueExtensions.EnqueueAsync (dispatcher, function, priority)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Toolkit.Uwp</AssemblyName>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>7.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="dispatcher" Type="Windows.System.DispatcherQueue" RefType="this" />
<Parameter Name="function" Type="System.Action" />
<Parameter Name="priority" Type="Windows.System.DispatcherQueuePriority" />
</Parameters>
<Docs>
<param name="dispatcher">The target <see cref="T:Windows.System.DispatcherQueue" /> to invoke the code on.</param>
<param name="function">The <see cref="T:System.Action" /> to invoke.</param>
<param name="priority">The priority level for the function to invoke.</param>
<summary>
Invokes a given function on the target <see cref="T:Windows.System.DispatcherQueue" /> and returns a
<see cref="T:System.Threading.Tasks.Task" /> that completes when the invocation of the function is completed.
</summary>
<returns>A <see cref="T:System.Threading.Tasks.Task" /> that completes when the invocation of <paramref name="function" /> is over.</returns>
<remarks>If the current thread has access to <paramref name="dispatcher" />, <paramref name="function" /> will be invoked directly.</remarks>
</Docs>
</Member>
<Member MemberName="EnqueueAsync">
<MemberSignature Language="C#" Value="public static System.Threading.Tasks.Task EnqueueAsync (this Windows.System.DispatcherQueue dispatcher, Func<System.Threading.Tasks.Task> function, Windows.System.DispatcherQueuePriority priority = Windows.System.DispatcherQueuePriority.Normal);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Threading.Tasks.Task EnqueueAsync(class Windows.System.DispatcherQueue dispatcher, class System.Func`1<class System.Threading.Tasks.Task> function, valuetype Windows.System.DispatcherQueuePriority priority) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Toolkit.Uwp.DispatcherQueueExtensions.EnqueueAsync(Windows.System.DispatcherQueue,System.Func{System.Threading.Tasks.Task},Windows.System.DispatcherQueuePriority)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function EnqueueAsync (dispatcher As DispatcherQueue, function As Func(Of Task), Optional priority As DispatcherQueuePriority = Windows.System.DispatcherQueuePriority.Normal) As Task" />
<MemberSignature Language="F#" Value="static member EnqueueAsync : Windows.System.DispatcherQueue * Func<System.Threading.Tasks.Task> * Windows.System.DispatcherQueuePriority -> System.Threading.Tasks.Task" Usage="Microsoft.Toolkit.Uwp.DispatcherQueueExtensions.EnqueueAsync (dispatcher, function, priority)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Toolkit.Uwp</AssemblyName>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>7.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="dispatcher" Type="Windows.System.DispatcherQueue" RefType="this" />
<Parameter Name="function" Type="System.Func<System.Threading.Tasks.Task>" />
<Parameter Name="priority" Type="Windows.System.DispatcherQueuePriority" />
</Parameters>
<Docs>
<param name="dispatcher">The target <see cref="T:Windows.System.DispatcherQueue" /> to invoke the code on.</param>
<param name="function">The <see cref="T:System.Func`1" /> to invoke.</param>
<param name="priority">The priority level for the function to invoke.</param>
<summary>
Invokes a given function on the target <see cref="T:Windows.System.DispatcherQueue" /> and returns a
<see cref="T:System.Threading.Tasks.Task" /> that acts as a proxy for the one returned by the given function.
</summary>
<returns>A <see cref="T:System.Threading.Tasks.Task" /> that acts as a proxy for the one returned by <paramref name="function" />.</returns>
<remarks>If the current thread has access to <paramref name="dispatcher" />, <paramref name="function" /> will be invoked directly.</remarks>
</Docs>
</Member>
<Member MemberName="EnqueueAsync<T>">
<MemberSignature Language="C#" Value="public static System.Threading.Tasks.Task<T> EnqueueAsync<T> (this Windows.System.DispatcherQueue dispatcher, Func<System.Threading.Tasks.Task<T>> function, Windows.System.DispatcherQueuePriority priority = Windows.System.DispatcherQueuePriority.Normal);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Threading.Tasks.Task`1<!!T> EnqueueAsync<T>(class Windows.System.DispatcherQueue dispatcher, class System.Func`1<class System.Threading.Tasks.Task`1<!!T>> function, valuetype Windows.System.DispatcherQueuePriority priority) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Toolkit.Uwp.DispatcherQueueExtensions.EnqueueAsync``1(Windows.System.DispatcherQueue,System.Func{System.Threading.Tasks.Task{``0}},Windows.System.DispatcherQueuePriority)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function EnqueueAsync(Of T) (dispatcher As DispatcherQueue, function As Func(Of Task(Of T)), Optional priority As DispatcherQueuePriority = Windows.System.DispatcherQueuePriority.Normal) As Task(Of T)" />
<MemberSignature Language="F#" Value="static member EnqueueAsync : Windows.System.DispatcherQueue * Func<System.Threading.Tasks.Task<'T>> * Windows.System.DispatcherQueuePriority -> System.Threading.Tasks.Task<'T>" Usage="Microsoft.Toolkit.Uwp.DispatcherQueueExtensions.EnqueueAsync (dispatcher, function, priority)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Toolkit.Uwp</AssemblyName>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>7.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<T></ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="T" />
</TypeParameters>
<Parameters>
<Parameter Name="dispatcher" Type="Windows.System.DispatcherQueue" RefType="this" />
<Parameter Name="function" Type="System.Func<System.Threading.Tasks.Task<T>>" />
<Parameter Name="priority" Type="Windows.System.DispatcherQueuePriority" />
</Parameters>
<Docs>
<typeparam name="T">The return type of <paramref name="function" /> to relay through the returned <see cref="T:System.Threading.Tasks.Task`1" />.</typeparam>
<param name="dispatcher">The target <see cref="T:Windows.System.DispatcherQueue" /> to invoke the code on.</param>
<param name="function">The <see cref="T:System.Func`1" /> to invoke.</param>
<param name="priority">The priority level for the function to invoke.</param>
<summary>
Invokes a given function on the target <see cref="T:Windows.System.DispatcherQueue" /> and returns a
<see cref="T:System.Threading.Tasks.Task`1" /> that acts as a proxy for the one returned by the given function.
</summary>
<returns>A <see cref="T:System.Threading.Tasks.Task`1" /> that relays the one returned by <paramref name="function" />.</returns>
<remarks>If the current thread has access to <paramref name="dispatcher" />, <paramref name="function" /> will be invoked directly.</remarks>
</Docs>
</Member>
<Member MemberName="EnqueueAsync<T>">
<MemberSignature Language="C#" Value="public static System.Threading.Tasks.Task<T> EnqueueAsync<T> (this Windows.System.DispatcherQueue dispatcher, Func<T> function, Windows.System.DispatcherQueuePriority priority = Windows.System.DispatcherQueuePriority.Normal);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Threading.Tasks.Task`1<!!T> EnqueueAsync<T>(class Windows.System.DispatcherQueue dispatcher, class System.Func`1<!!T> function, valuetype Windows.System.DispatcherQueuePriority priority) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Toolkit.Uwp.DispatcherQueueExtensions.EnqueueAsync``1(Windows.System.DispatcherQueue,System.Func{``0},Windows.System.DispatcherQueuePriority)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function EnqueueAsync(Of T) (dispatcher As DispatcherQueue, function As Func(Of T), Optional priority As DispatcherQueuePriority = Windows.System.DispatcherQueuePriority.Normal) As Task(Of T)" />
<MemberSignature Language="F#" Value="static member EnqueueAsync : Windows.System.DispatcherQueue * Func<'T> * Windows.System.DispatcherQueuePriority -> System.Threading.Tasks.Task<'T>" Usage="Microsoft.Toolkit.Uwp.DispatcherQueueExtensions.EnqueueAsync (dispatcher, function, priority)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Toolkit.Uwp</AssemblyName>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>7.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<T></ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="T" />
</TypeParameters>
<Parameters>
<Parameter Name="dispatcher" Type="Windows.System.DispatcherQueue" RefType="this" />
<Parameter Name="function" Type="System.Func<T>" />
<Parameter Name="priority" Type="Windows.System.DispatcherQueuePriority" />
</Parameters>
<Docs>
<typeparam name="T">The return type of <paramref name="function" /> to relay through the returned <see cref="T:System.Threading.Tasks.Task`1" />.</typeparam>
<param name="dispatcher">The target <see cref="T:Windows.System.DispatcherQueue" /> to invoke the code on.</param>
<param name="function">The <see cref="T:System.Func`1" /> to invoke.</param>
<param name="priority">The priority level for the function to invoke.</param>
<summary>
Invokes a given function on the target <see cref="T:Windows.System.DispatcherQueue" /> and returns a
<see cref="T:System.Threading.Tasks.Task`1" /> that completes when the invocation of the function is completed.
</summary>
<returns>A <see cref="T:System.Threading.Tasks.Task" /> that completes when the invocation of <paramref name="function" /> is over.</returns>
<remarks>If the current thread has access to <paramref name="dispatcher" />, <paramref name="function" /> will be invoked directly.</remarks>
</Docs>
</Member>
</Members>
</Type>