-
Notifications
You must be signed in to change notification settings - Fork 24
/
Subscriber.xml
157 lines (157 loc) · 8.14 KB
/
Subscriber.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
<Type Name="Subscriber" FullName="Microsoft.Rtc.Collaboration.Presence.Subscriber">
<TypeSignature Language="C#" Value="public class Subscriber" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit Subscriber extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Rtc.Collaboration.Presence.Subscriber" />
<TypeSignature Language="VB.NET" Value="Public Class Subscriber" />
<TypeSignature Language="C++ CLI" Value="public ref class Subscriber" />
<TypeSignature Language="F#" Value="type Subscriber = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Represents a watcher who wishes to subscribe to the current endpoint owner's presence.
</summary>
<remarks>
<para>
Subscribers are entities who subscribe to the endpoint owner's presence with "context". In this case, the server
informs that belong to this owner that someone has requested access to presence information. One of these endpoints
can then acknowledge this request.
</para>
<para>
Information about the subscriber includes the display name, URI, whether this subsciber has already been acknowledged
or the network type the subscriber belongs to. This also allows the endpoint acknowledging the subscriber to
allow access by assigning an appropriate membership level using the <see cref="T:Microsoft.Rtc.Collaboration.Presence.ContainerUpdateOperation" /> class.
</para>
<para>
The <see cref="P:Microsoft.Rtc.Collaboration.Presence.Subscriber.ContextData" /> has special meaning when the subscriber is a delegate.
</para>
<para />
</remarks>
</Docs>
<Members>
<Member MemberName="ContextData">
<MemberSignature Language="C#" Value="public string ContextData { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string ContextData" />
<MemberSignature Language="DocId" Value="P:Microsoft.Rtc.Collaboration.Presence.Subscriber.ContextData" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property ContextData As String" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ ContextData { System::String ^ get(); };" />
<MemberSignature Language="F#" Value="member this.ContextData : string" Usage="Microsoft.Rtc.Collaboration.Presence.Subscriber.ContextData" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the context data of the subscription
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="DisplayName">
<MemberSignature Language="C#" Value="public string DisplayName { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string DisplayName" />
<MemberSignature Language="DocId" Value="P:Microsoft.Rtc.Collaboration.Presence.Subscriber.DisplayName" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property DisplayName As String" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ DisplayName { System::String ^ get(); };" />
<MemberSignature Language="F#" Value="member this.DisplayName : string" Usage="Microsoft.Rtc.Collaboration.Presence.Subscriber.DisplayName" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the display name of the target
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Id">
<MemberSignature Language="C#" Value="public string Id { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Id" />
<MemberSignature Language="DocId" Value="P:Microsoft.Rtc.Collaboration.Presence.Subscriber.Id" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Id As String" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ Id { System::String ^ get(); };" />
<MemberSignature Language="F#" Value="member this.Id : string" Usage="Microsoft.Rtc.Collaboration.Presence.Subscriber.Id" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the address of the target
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="IsAcknowledged">
<MemberSignature Language="C#" Value="public bool IsAcknowledged { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool IsAcknowledged" />
<MemberSignature Language="DocId" Value="P:Microsoft.Rtc.Collaboration.Presence.Subscriber.IsAcknowledged" />
<MemberSignature Language="VB.NET" Value="Public Property IsAcknowledged As Boolean" />
<MemberSignature Language="C++ CLI" Value="public:
 property bool IsAcknowledged { bool get(); void set(bool value); };" />
<MemberSignature Language="F#" Value="member this.IsAcknowledged : bool with get, set" Usage="Microsoft.Rtc.Collaboration.Presence.Subscriber.IsAcknowledged" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the boolean value whether the contact has acknowledged the subscription
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="NetworkType">
<MemberSignature Language="C#" Value="public Microsoft.Rtc.Collaboration.SourceNetwork NetworkType { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Microsoft.Rtc.Collaboration.SourceNetwork NetworkType" />
<MemberSignature Language="DocId" Value="P:Microsoft.Rtc.Collaboration.Presence.Subscriber.NetworkType" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property NetworkType As SourceNetwork" />
<MemberSignature Language="C++ CLI" Value="public:
 property Microsoft::Rtc::Collaboration::SourceNetwork NetworkType { Microsoft::Rtc::Collaboration::SourceNetwork get(); };" />
<MemberSignature Language="F#" Value="member this.NetworkType : Microsoft.Rtc.Collaboration.SourceNetwork" Usage="Microsoft.Rtc.Collaboration.Presence.Subscriber.NetworkType" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Rtc.Collaboration.SourceNetwork</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the source network that the target contact belongs to
</summary>
<value>To be added.</value>
<remarks>
<para>Whether publicCloud/federated/sameEnterprise/none</para>
<para />
</remarks>
</Docs>
</Member>
</Members>
</Type>