-
Notifications
You must be signed in to change notification settings - Fork 11
/
ChatRoomFileDownloadJob.xml
169 lines (169 loc) · 10.6 KB
/
ChatRoomFileDownloadJob.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
161
162
163
164
165
166
167
168
169
<Type Name="ChatRoomFileDownloadJob" FullName="Microsoft.Rtc.Collaboration.PersistentChat.ChatRoomFileDownloadJob">
<TypeSignature Language="C#" Value="public class ChatRoomFileDownloadJob" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit ChatRoomFileDownloadJob extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Rtc.Collaboration.PersistentChat.ChatRoomFileDownloadJob" />
<TypeSignature Language="VB.NET" Value="Public Class ChatRoomFileDownloadJob" />
<TypeSignature Language="C++ CLI" Value="public ref class ChatRoomFileDownloadJob" />
<TypeSignature Language="F#" Value="type ChatRoomFileDownloadJob = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration.PersistentChat</AssemblyName>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Provides metadata and controls for handling a file download operation with a chat room.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ChatRoomFileDownloadJob (Microsoft.Rtc.Collaboration.PersistentChat.MessagePartFileDownloadLink link, string destinationPath);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class Microsoft.Rtc.Collaboration.PersistentChat.MessagePartFileDownloadLink link, string destinationPath) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Rtc.Collaboration.PersistentChat.ChatRoomFileDownloadJob.#ctor(Microsoft.Rtc.Collaboration.PersistentChat.MessagePartFileDownloadLink,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (link As MessagePartFileDownloadLink, destinationPath As String)" />
<MemberSignature Language="C++ CLI" Value="public:
 ChatRoomFileDownloadJob(Microsoft::Rtc::Collaboration::PersistentChat::MessagePartFileDownloadLink ^ link, System::String ^ destinationPath);" />
<MemberSignature Language="F#" Value="new Microsoft.Rtc.Collaboration.PersistentChat.ChatRoomFileDownloadJob : Microsoft.Rtc.Collaboration.PersistentChat.MessagePartFileDownloadLink * string -> Microsoft.Rtc.Collaboration.PersistentChat.ChatRoomFileDownloadJob" Usage="new Microsoft.Rtc.Collaboration.PersistentChat.ChatRoomFileDownloadJob (link, destinationPath)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration.PersistentChat</AssemblyName>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="link" Type="Microsoft.Rtc.Collaboration.PersistentChat.MessagePartFileDownloadLink" />
<Parameter Name="destinationPath" Type="System.String" />
</Parameters>
<Docs>
<param name="link">The file download link, obtained from <see cref="P:Microsoft.Rtc.Collaboration.PersistentChat.ChatMessage.FormattedMessageParts" />.</param>
<param name="destinationPath">The destination path.</param>
<summary>
Initializes a new instance of the <see cref="T:Microsoft.Rtc.Collaboration.PersistentChat.ChatRoomFileDownloadJob" /> class.
</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentException">
<paramref name="destinationPath" /> is null or empty.</exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="link" /> is null.</exception>
</Docs>
</Member>
<Member MemberName="CancelJob">
<MemberSignature Language="C#" Value="public void CancelJob ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void CancelJob() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Rtc.Collaboration.PersistentChat.ChatRoomFileDownloadJob.CancelJob" />
<MemberSignature Language="VB.NET" Value="Public Sub CancelJob ()" />
<MemberSignature Language="C++ CLI" Value="public:
 void CancelJob();" />
<MemberSignature Language="F#" Value="member this.CancelJob : unit -> unit" Usage="chatRoomFileDownloadJob.CancelJob " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration.PersistentChat</AssemblyName>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Cancels the job. This request is issued asynchronously.
When the cancellation is made effective, the <see cref="E:Microsoft.Rtc.Collaboration.PersistentChat.ChatRoomFileDownloadJob.ProgressChanged" /> event will be fired,
and the <see cref="P:Microsoft.Rtc.Collaboration.PersistentChat.ChatRoomFileTransferProgressEventArgs.Cancelled" /> property will be set to <see cref="true" />.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="DestinationPath">
<MemberSignature Language="C#" Value="public string DestinationPath { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string DestinationPath" />
<MemberSignature Language="DocId" Value="P:Microsoft.Rtc.Collaboration.PersistentChat.ChatRoomFileDownloadJob.DestinationPath" />
<MemberSignature Language="VB.NET" Value="Public Property DestinationPath As String" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ DestinationPath { System::String ^ get(); void set(System::String ^ value); };" />
<MemberSignature Language="F#" Value="member this.DestinationPath : string with get, set" Usage="Microsoft.Rtc.Collaboration.PersistentChat.ChatRoomFileDownloadJob.DestinationPath" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration.PersistentChat</AssemblyName>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the path to which the downloaded file will be saved.
</summary>
<value>The destination path.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="PercentComplete">
<MemberSignature Language="C#" Value="public int PercentComplete { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 PercentComplete" />
<MemberSignature Language="DocId" Value="P:Microsoft.Rtc.Collaboration.PersistentChat.ChatRoomFileDownloadJob.PercentComplete" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property PercentComplete As Integer" />
<MemberSignature Language="C++ CLI" Value="public:
 property int PercentComplete { int get(); };" />
<MemberSignature Language="F#" Value="member this.PercentComplete : int" Usage="Microsoft.Rtc.Collaboration.PersistentChat.ChatRoomFileDownloadJob.PercentComplete" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration.PersistentChat</AssemblyName>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the percent complete.
</summary>
<value>The percent complete.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ProgressChanged">
<MemberSignature Language="C#" Value="public event EventHandler<Microsoft.Rtc.Collaboration.PersistentChat.ChatRoomFileTransferProgressEventArgs> ProgressChanged;" />
<MemberSignature Language="ILAsm" Value=".event class System.EventHandler`1<class Microsoft.Rtc.Collaboration.PersistentChat.ChatRoomFileTransferProgressEventArgs> ProgressChanged" />
<MemberSignature Language="DocId" Value="E:Microsoft.Rtc.Collaboration.PersistentChat.ChatRoomFileDownloadJob.ProgressChanged" />
<MemberSignature Language="VB.NET" Value="Public Custom Event ProgressChanged As EventHandler(Of ChatRoomFileTransferProgressEventArgs) " />
<MemberSignature Language="C++ CLI" Value="public:
 event EventHandler<Microsoft::Rtc::Collaboration::PersistentChat::ChatRoomFileTransferProgressEventArgs ^> ^ ProgressChanged;" />
<MemberSignature Language="F#" Value="member this.ProgressChanged : EventHandler<Microsoft.Rtc.Collaboration.PersistentChat.ChatRoomFileTransferProgressEventArgs> " Usage="member this.ProgressChanged : System.EventHandler<Microsoft.Rtc.Collaboration.PersistentChat.ChatRoomFileTransferProgressEventArgs> " />
<MemberType>Event</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration.PersistentChat</AssemblyName>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.EventHandler<Microsoft.Rtc.Collaboration.PersistentChat.ChatRoomFileTransferProgressEventArgs></ReturnType>
</ReturnValue>
<Docs>
<summary>
Occurs when file transfer progress has changed.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SourceUrl">
<MemberSignature Language="C#" Value="public string SourceUrl { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string SourceUrl" />
<MemberSignature Language="DocId" Value="P:Microsoft.Rtc.Collaboration.PersistentChat.ChatRoomFileDownloadJob.SourceUrl" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property SourceUrl As String" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ SourceUrl { System::String ^ get(); };" />
<MemberSignature Language="F#" Value="member this.SourceUrl : string" Usage="Microsoft.Rtc.Collaboration.PersistentChat.ChatRoomFileDownloadJob.SourceUrl" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration.PersistentChat</AssemblyName>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the URL of the file that is being downloaded
</summary>
<value>The source URL.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>