-
Notifications
You must be signed in to change notification settings - Fork 24
/
UserEndpointPresenceServices.xml
321 lines (321 loc) · 22.8 KB
/
UserEndpointPresenceServices.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
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
<Type Name="UserEndpointPresenceServices" FullName="Microsoft.Rtc.Collaboration.UserEndpointPresenceServices">
<TypeSignature Language="C#" Value="public class UserEndpointPresenceServices : Microsoft.Rtc.Collaboration.LocalEndpointPresenceServices" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit UserEndpointPresenceServices extends Microsoft.Rtc.Collaboration.LocalEndpointPresenceServices" />
<TypeSignature Language="DocId" Value="T:Microsoft.Rtc.Collaboration.UserEndpointPresenceServices" />
<TypeSignature Language="VB.NET" Value="Public Class UserEndpointPresenceServices
Inherits LocalEndpointPresenceServices" />
<TypeSignature Language="C++ CLI" Value="public ref class UserEndpointPresenceServices : Microsoft::Rtc::Collaboration::LocalEndpointPresenceServices" />
<TypeSignature Language="F#" Value="type UserEndpointPresenceServices = class
 inherit LocalEndpointPresenceServices" />
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Microsoft.Rtc.Collaboration.LocalEndpointPresenceServices</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
This class provides common presence services for <see cref="T:Microsoft.Rtc.Collaboration.UserEndpoint" />.
</summary>
<remarks>
<para>
Applications are allowed to publish the user and endpoint presence states and also update any privacy preferences. Any published user states
can also be deleted.
</para>
<para />
</remarks>
</Docs>
<Members>
<Member MemberName="BeginDeleteUserPresenceState">
<MemberSignature Language="C#" Value="public IAsyncResult BeginDeleteUserPresenceState (AsyncCallback userCallback, object state);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.IAsyncResult BeginDeleteUserPresenceState(class System.AsyncCallback userCallback, object state) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Rtc.Collaboration.UserEndpointPresenceServices.BeginDeleteUserPresenceState(System.AsyncCallback,System.Object)" />
<MemberSignature Language="VB.NET" Value="Public Function BeginDeleteUserPresenceState (userCallback As AsyncCallback, state As Object) As IAsyncResult" />
<MemberSignature Language="C++ CLI" Value="public:
 IAsyncResult ^ BeginDeleteUserPresenceState(AsyncCallback ^ userCallback, System::Object ^ state);" />
<MemberSignature Language="F#" Value="member this.BeginDeleteUserPresenceState : AsyncCallback * obj -> IAsyncResult" Usage="userEndpointPresenceServices.BeginDeleteUserPresenceState (userCallback, state)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.IAsyncResult</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="userCallback" Type="System.AsyncCallback" />
<Parameter Name="state" Type="System.Object" />
</Parameters>
<Docs>
<param name="userCallback">The method to be called when the asynchronous operation is completed.</param>
<param name="state">A user-provided object that distinguishes this particular asynchronous operation from other asynchronous operations.</param>
<summary>
Begins an asynchronous operation to delete all maunally published User presence states.
</summary>
<returns>An IAsyncResult that references the asynchronous operation.</returns>
<remarks>
<para>
User PresenceState is typically published by the client, when user manually set the PresenceState in UI.
This method allows application to delete all manual user PresenceState publication and reset the presence state
to depend only on application's automatic presence state publications.
</para>
<para />
</remarks>
<exception cref="T:System.InvalidOperationException">Thrown when the endpoint is not in the "registered" state.</exception>
</Docs>
</Member>
<Member MemberName="BeginUpdatePresenceState">
<MemberSignature Language="C#" Value="public IAsyncResult BeginUpdatePresenceState (Microsoft.Rtc.Collaboration.Presence.PresenceState newState, AsyncCallback userCallback, object state);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.IAsyncResult BeginUpdatePresenceState(class Microsoft.Rtc.Collaboration.Presence.PresenceState newState, class System.AsyncCallback userCallback, object state) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Rtc.Collaboration.UserEndpointPresenceServices.BeginUpdatePresenceState(Microsoft.Rtc.Collaboration.Presence.PresenceState,System.AsyncCallback,System.Object)" />
<MemberSignature Language="VB.NET" Value="Public Function BeginUpdatePresenceState (newState As PresenceState, userCallback As AsyncCallback, state As Object) As IAsyncResult" />
<MemberSignature Language="C++ CLI" Value="public:
 IAsyncResult ^ BeginUpdatePresenceState(Microsoft::Rtc::Collaboration::Presence::PresenceState ^ newState, AsyncCallback ^ userCallback, System::Object ^ state);" />
<MemberSignature Language="F#" Value="member this.BeginUpdatePresenceState : Microsoft.Rtc.Collaboration.Presence.PresenceState * AsyncCallback * obj -> IAsyncResult" Usage="userEndpointPresenceServices.BeginUpdatePresenceState (newState, userCallback, state)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.IAsyncResult</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="newState" Type="Microsoft.Rtc.Collaboration.Presence.PresenceState" />
<Parameter Name="userCallback" Type="System.AsyncCallback" />
<Parameter Name="state" Type="System.Object" />
</Parameters>
<Docs>
<param name="newState">New user state for the endpoint, must be of type <see cref="F:Microsoft.Rtc.Collaboration.Presence.PresenceStateType.UserState" /> or <see cref="F:Microsoft.Rtc.Collaboration.Presence.PresenceStateType.EndpointState" />.</param>
<param name="userCallback">The method to be called when the asynchronous operation is completed.</param>
<param name="state">A user-provided object that distinguishes this particular asynchronous operation from other asynchronous operations.</param>
<summary>
Begins an asynchronous operation to publish the user or endpoint presence state.
</summary>
<returns>An IAsyncResult that references the asynchronous operation.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.InvalidOperationException">Thrown when the endpoint is not in the "registered" state, or the current state of <see cref="T:Microsoft.Rtc.Collaboration.Presence.LocalOwnerPresence" /> is not "subscribed".</exception>
<exception cref="T:System.ArgumentNullException">Thrown when <paramref name="newState" /> passed is null.</exception>
<exception cref="T:System.ArgumentException">Thrown when <paramref name="newState" /> is not of type <see cref="F:Microsoft.Rtc.Collaboration.Presence.PresenceStateType.UserState" />
or <see cref="F:Microsoft.Rtc.Collaboration.Presence.PresenceStateType.EndpointState" />.</exception>
</Docs>
</Member>
<Member MemberName="BeginUpdatePrivacyPreference">
<MemberSignature Language="C#" Value="public IAsyncResult BeginUpdatePrivacyPreference (Microsoft.Rtc.Collaboration.Presence.PrivacyModePreference privacyPreference, AsyncCallback userCallback, object state);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.IAsyncResult BeginUpdatePrivacyPreference(valuetype Microsoft.Rtc.Collaboration.Presence.PrivacyModePreference privacyPreference, class System.AsyncCallback userCallback, object state) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Rtc.Collaboration.UserEndpointPresenceServices.BeginUpdatePrivacyPreference(Microsoft.Rtc.Collaboration.Presence.PrivacyModePreference,System.AsyncCallback,System.Object)" />
<MemberSignature Language="VB.NET" Value="Public Function BeginUpdatePrivacyPreference (privacyPreference As PrivacyModePreference, userCallback As AsyncCallback, state As Object) As IAsyncResult" />
<MemberSignature Language="C++ CLI" Value="public:
 IAsyncResult ^ BeginUpdatePrivacyPreference(Microsoft::Rtc::Collaboration::Presence::PrivacyModePreference privacyPreference, AsyncCallback ^ userCallback, System::Object ^ state);" />
<MemberSignature Language="F#" Value="member this.BeginUpdatePrivacyPreference : Microsoft.Rtc.Collaboration.Presence.PrivacyModePreference * AsyncCallback * obj -> IAsyncResult" Usage="userEndpointPresenceServices.BeginUpdatePrivacyPreference (privacyPreference, userCallback, state)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.IAsyncResult</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="privacyPreference" Type="Microsoft.Rtc.Collaboration.Presence.PrivacyModePreference" />
<Parameter Name="userCallback" Type="System.AsyncCallback" />
<Parameter Name="state" Type="System.Object" />
</Parameters>
<Docs>
<param name="privacyPreference">Value indicating what the local owner's privacy preference would be.</param>
<param name="userCallback">The method to be called when the asynchronous operation is completed.</param>
<param name="state">A user-provided object that distinguishes this particular asynchronous operation from other asynchronous operations.</param>
<summary>
Begins an asynchronous operation to set the local owner preferred privacy mode.
</summary>
<returns>An IAsyncResult that references the asynchronous operation.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.InvalidOperationException">Thrown when the endpoint is not a user endpoint or subscribed to this session.</exception>
</Docs>
</Member>
<Member MemberName="EndDeleteUserPresenceState">
<MemberSignature Language="C#" Value="public void EndDeleteUserPresenceState (IAsyncResult result);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void EndDeleteUserPresenceState(class System.IAsyncResult result) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Rtc.Collaboration.UserEndpointPresenceServices.EndDeleteUserPresenceState(System.IAsyncResult)" />
<MemberSignature Language="VB.NET" Value="Public Sub EndDeleteUserPresenceState (result As IAsyncResult)" />
<MemberSignature Language="C++ CLI" Value="public:
 void EndDeleteUserPresenceState(IAsyncResult ^ result);" />
<MemberSignature Language="F#" Value="member this.EndDeleteUserPresenceState : IAsyncResult -> unit" Usage="userEndpointPresenceServices.EndDeleteUserPresenceState result" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="result" Type="System.IAsyncResult" />
</Parameters>
<Docs>
<param name="result">The reference to the pending asynchronous operation.</param>
<summary>
Completes the asynchronous operation started by BeginDeleteUserPresenceState
</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.InvalidOperationException">
Thrown when this method is invoked multiple times using the same asyncResult.
</exception>
<exception cref="T:System.ArgumentNullException">
Thrown when the <paramref name="result" /> parameter is null.
</exception>
<exception cref="T:System.ArgumentException">
Thrown when the <paramref name="result" /> parameter is invalid.
</exception>
</Docs>
</Member>
<Member MemberName="EndUpdatePresenceState">
<MemberSignature Language="C#" Value="public void EndUpdatePresenceState (IAsyncResult result);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void EndUpdatePresenceState(class System.IAsyncResult result) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Rtc.Collaboration.UserEndpointPresenceServices.EndUpdatePresenceState(System.IAsyncResult)" />
<MemberSignature Language="VB.NET" Value="Public Sub EndUpdatePresenceState (result As IAsyncResult)" />
<MemberSignature Language="C++ CLI" Value="public:
 void EndUpdatePresenceState(IAsyncResult ^ result);" />
<MemberSignature Language="F#" Value="member this.EndUpdatePresenceState : IAsyncResult -> unit" Usage="userEndpointPresenceServices.EndUpdatePresenceState result" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="result" Type="System.IAsyncResult" />
</Parameters>
<Docs>
<param name="result">The reference to the pending asynchronous operation.</param>
<summary>
Completes the asynchronous operation started by BeginUpdatePresenceState
</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.InvalidOperationException">
Thrown when this method is invoked multiple times using the same asyncResult.
</exception>
<exception cref="T:System.ArgumentNullException">
Thrown when the <paramref name="result" /> parameter is null.
</exception>
<exception cref="T:System.ArgumentException">
Thrown when the <paramref name="result" /> parameter is invalid.
</exception>
</Docs>
</Member>
<Member MemberName="EndUpdatePrivacyPreference">
<MemberSignature Language="C#" Value="public void EndUpdatePrivacyPreference (IAsyncResult result);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void EndUpdatePrivacyPreference(class System.IAsyncResult result) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Rtc.Collaboration.UserEndpointPresenceServices.EndUpdatePrivacyPreference(System.IAsyncResult)" />
<MemberSignature Language="VB.NET" Value="Public Sub EndUpdatePrivacyPreference (result As IAsyncResult)" />
<MemberSignature Language="C++ CLI" Value="public:
 void EndUpdatePrivacyPreference(IAsyncResult ^ result);" />
<MemberSignature Language="F#" Value="member this.EndUpdatePrivacyPreference : IAsyncResult -> unit" Usage="userEndpointPresenceServices.EndUpdatePrivacyPreference result" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="result" Type="System.IAsyncResult" />
</Parameters>
<Docs>
<param name="result">The reference to the pending asynchronous operation.</param>
<summary>
Completes the asynchronous operation initiated by BeginUpdatePrivacyPreference.
</summary>
<remarks>
<para>
PublishSubscribeException is usually thrown when the request sent to the server is invalid.
</para>
<para />
</remarks>
<exception cref="T:System.ArgumentException">Thrown when the argument passed is null or invalid.</exception>
<exception cref="T:System.InvalidOperationException">Thrown when this method is invoked multiple times using the same result.</exception>
<exception cref="T:Microsoft.Rtc.Signaling.PublishSubscribeException">Thrown when the SIP SERVICE request is rejected by the server.</exception>
<exception cref="T:Microsoft.Rtc.Signaling.OperationFailureException">Thrown when the underlying subscription changed during the publish operation or an empty container update operation is specified.</exception>
<exception cref="T:Microsoft.Rtc.Signaling.RealTimeException">Thrown when SIP Transport, SIP authentication and credential-related errors are encountered.</exception>
</Docs>
</Member>
<Member MemberName="GetPresenceRelationshipLevel">
<MemberSignature Language="C#" Value="public Microsoft.Rtc.Collaboration.Presence.PresenceRelationshipLevel GetPresenceRelationshipLevel (Microsoft.Rtc.Signaling.RealTimeAddress uri, Microsoft.Rtc.Collaboration.SourceNetwork sourceNetwork);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance valuetype Microsoft.Rtc.Collaboration.Presence.PresenceRelationshipLevel GetPresenceRelationshipLevel(class Microsoft.Rtc.Signaling.RealTimeAddress uri, valuetype Microsoft.Rtc.Collaboration.SourceNetwork sourceNetwork) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Rtc.Collaboration.UserEndpointPresenceServices.GetPresenceRelationshipLevel(Microsoft.Rtc.Signaling.RealTimeAddress,Microsoft.Rtc.Collaboration.SourceNetwork)" />
<MemberSignature Language="C++ CLI" Value="public:
 Microsoft::Rtc::Collaboration::Presence::PresenceRelationshipLevel GetPresenceRelationshipLevel(Microsoft::Rtc::Signaling::RealTimeAddress ^ uri, Microsoft::Rtc::Collaboration::SourceNetwork sourceNetwork);" />
<MemberSignature Language="F#" Value="member this.GetPresenceRelationshipLevel : Microsoft.Rtc.Signaling.RealTimeAddress * Microsoft.Rtc.Collaboration.SourceNetwork -> Microsoft.Rtc.Collaboration.Presence.PresenceRelationshipLevel" Usage="userEndpointPresenceServices.GetPresenceRelationshipLevel (uri, sourceNetwork)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Rtc.Collaboration.Presence.PresenceRelationshipLevel</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="uri" Type="Microsoft.Rtc.Signaling.RealTimeAddress" />
<Parameter Name="sourceNetwork" Type="Microsoft.Rtc.Collaboration.SourceNetwork" />
</Parameters>
<Docs>
<param name="uri">URI of the UC entity.</param>
<param name="sourceNetwork">Network type that this entity belongs to.</param>
<summary>
Retrieves the highest container membership match for a UC entity.
</summary>
<returns>The highest container that this entity belongs to.</returns>
<remarks>
<para>Matching will be performed in the following order:</para>
<para>1) Exact URI match</para>
<para>2) Best domain match</para>
<para>3) Source network type match</para>
<para />
</remarks>
<exception cref="T:System.ArgumentNullException">Thrown when <paramref name="uri" /> is null.</exception>
</Docs>
</Member>
<Member MemberName="PrivacyMode">
<MemberSignature Language="C#" Value="public Microsoft.Rtc.Collaboration.Presence.PrivacyMode PrivacyMode { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Microsoft.Rtc.Collaboration.Presence.PrivacyMode PrivacyMode" />
<MemberSignature Language="DocId" Value="P:Microsoft.Rtc.Collaboration.UserEndpointPresenceServices.PrivacyMode" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property PrivacyMode As PrivacyMode" />
<MemberSignature Language="C++ CLI" Value="public:
 property Microsoft::Rtc::Collaboration::Presence::PrivacyMode PrivacyMode { Microsoft::Rtc::Collaboration::Presence::PrivacyMode get(); };" />
<MemberSignature Language="F#" Value="member this.PrivacyMode : Microsoft.Rtc.Collaboration.Presence.PrivacyMode" Usage="Microsoft.Rtc.Collaboration.UserEndpointPresenceServices.PrivacyMode" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Rtc.Collaboration.Presence.PrivacyMode</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the local owner's current privacy mode.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="PrivacyModePreference">
<MemberSignature Language="C#" Value="public Microsoft.Rtc.Collaboration.Presence.PrivacyModePreference PrivacyModePreference { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Microsoft.Rtc.Collaboration.Presence.PrivacyModePreference PrivacyModePreference" />
<MemberSignature Language="DocId" Value="P:Microsoft.Rtc.Collaboration.UserEndpointPresenceServices.PrivacyModePreference" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property PrivacyModePreference As PrivacyModePreference" />
<MemberSignature Language="C++ CLI" Value="public:
 property Microsoft::Rtc::Collaboration::Presence::PrivacyModePreference PrivacyModePreference { Microsoft::Rtc::Collaboration::Presence::PrivacyModePreference get(); };" />
<MemberSignature Language="F#" Value="member this.PrivacyModePreference : Microsoft.Rtc.Collaboration.Presence.PrivacyModePreference" Usage="Microsoft.Rtc.Collaboration.UserEndpointPresenceServices.PrivacyModePreference" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Rtc.Collaboration.Presence.PrivacyModePreference</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the local owner's privacy preference
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>