/
IAsyncFlushable.xml
58 lines (58 loc) · 3.26 KB
/
IAsyncFlushable.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
<Type Name="IAsyncFlushable" FullName="Microsoft.ApplicationInsights.Channel.IAsyncFlushable">
<TypeSignature Language="C#" Value="public interface IAsyncFlushable : IDisposable" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract IAsyncFlushable implements class System.IDisposable" />
<TypeSignature Language="DocId" Value="T:Microsoft.ApplicationInsights.Channel.IAsyncFlushable" />
<TypeSignature Language="VB.NET" Value="Public Interface IAsyncFlushable
Implements IDisposable" />
<TypeSignature Language="F#" Value="type IAsyncFlushable = interface
 interface IDisposable" />
<AssemblyInfo>
<AssemblyName>Microsoft.ApplicationInsights</AssemblyName>
<AssemblyVersion>2.18.0.315</AssemblyVersion>
<AssemblyVersion>2.19.0.227</AssemblyVersion>
<AssemblyVersion>2.20.0.103</AssemblyVersion>
<AssemblyVersion>2.21.0.429</AssemblyVersion>
<AssemblyVersion>2.22.0.405</AssemblyVersion>
</AssemblyInfo>
<Interfaces>
<Interface>
<InterfaceName>System.IDisposable</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<summary>
Represents a task based flush for sending telemetry to application insights.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="FlushAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<bool> FlushAsync (System.Threading.CancellationToken cancellationToken);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<bool> FlushAsync(valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ApplicationInsights.Channel.IAsyncFlushable.FlushAsync(System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function FlushAsync (cancellationToken As CancellationToken) As Task(Of Boolean)" />
<MemberSignature Language="F#" Value="abstract member FlushAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<bool>" Usage="iAsyncFlushable.FlushAsync cancellationToken" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ApplicationInsights</AssemblyName>
<AssemblyVersion>2.21.0.429</AssemblyVersion>
<AssemblyVersion>2.22.0.405</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<System.Boolean></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="cancellationToken">CancellationToken.</param>
<summary>
Flushes the in-memory buffer asynchronously.
</summary>
<returns>
Returns true when telemetry data is transferred out of process (application insights server or local storage) and are emitted before the flush invocation.
Returns false when transfer of telemetry data to server has failed with non-retriable http status code.
</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>