-
Notifications
You must be signed in to change notification settings - Fork 256
/
MicrosoftTeamsUserIdentifier.xml
197 lines (197 loc) · 11.8 KB
/
MicrosoftTeamsUserIdentifier.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
<Type Name="MicrosoftTeamsUserIdentifier" FullName="Azure.Communication.MicrosoftTeamsUserIdentifier">
<TypeSignature Language="C#" Value="public class MicrosoftTeamsUserIdentifier : Azure.Communication.CommunicationIdentifier" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit MicrosoftTeamsUserIdentifier extends Azure.Communication.CommunicationIdentifier" />
<TypeSignature Language="DocId" Value="T:Azure.Communication.MicrosoftTeamsUserIdentifier" />
<TypeSignature Language="VB.NET" Value="Public Class MicrosoftTeamsUserIdentifier
Inherits CommunicationIdentifier" />
<TypeSignature Language="F#" Value="type MicrosoftTeamsUserIdentifier = class
 inherit CommunicationIdentifier" />
<AssemblyInfo>
<AssemblyName>Azure.Communication.Common</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.0.1.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
<AssemblyVersion>1.2.0.0</AssemblyVersion>
<AssemblyVersion>1.2.1.0</AssemblyVersion>
<AssemblyVersion>1.3.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Azure.Communication.CommunicationIdentifier</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>Represents a Microsoft Teams user.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public MicrosoftTeamsUserIdentifier (string userId, bool isAnonymous = false, Azure.Communication.CommunicationCloudEnvironment? cloud = default, string rawId = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string userId, bool isAnonymous, valuetype System.Nullable`1<valuetype Azure.Communication.CommunicationCloudEnvironment> cloud, string rawId) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Communication.MicrosoftTeamsUserIdentifier.#ctor(System.String,System.Boolean,System.Nullable{Azure.Communication.CommunicationCloudEnvironment},System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (userId As String, Optional isAnonymous As Boolean = false, Optional cloud As Nullable(Of CommunicationCloudEnvironment) = Nothing, Optional rawId As String = Nothing)" />
<MemberSignature Language="F#" Value="new Azure.Communication.MicrosoftTeamsUserIdentifier : string * bool * Nullable<Azure.Communication.CommunicationCloudEnvironment> * string -> Azure.Communication.MicrosoftTeamsUserIdentifier" Usage="new Azure.Communication.MicrosoftTeamsUserIdentifier (userId, isAnonymous, cloud, rawId)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Communication.Common</AssemblyName>
<AssemblyVersion>1.3.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="userId" Type="System.String" />
<Parameter Name="isAnonymous" Type="System.Boolean" />
<Parameter Name="cloud" Type="System.Nullable<Azure.Communication.CommunicationCloudEnvironment>" />
<Parameter Name="rawId" Type="System.String" />
</Parameters>
<Docs>
<param name="userId">Id of the Microsoft Teams user. If the user isn't anonymous, the id is the Azure AD object id of the user.</param>
<param name="isAnonymous">Set this to true if the user is anonymous, for example when joining a meeting with a share link.</param>
<param name="cloud">The cloud that the Microsoft Team user belongs to. A null value translates to the Public cloud.</param>
<param name="rawId">Raw id of the Microsoft Teams user, optional.</param>
<summary>
Initializes a new instance of <see cref="T:Azure.Communication.MicrosoftTeamsUserIdentifier" />.
</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
Thrown when the <paramref name="userId" /> is null.
</exception>
<exception cref="T:System.ArgumentException">
Thrown when the <paramref name="userId" /> is empty.
</exception>
</Docs>
</Member>
<Member MemberName="Cloud">
<MemberSignature Language="C#" Value="public Azure.Communication.CommunicationCloudEnvironment Cloud { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Azure.Communication.CommunicationCloudEnvironment Cloud" />
<MemberSignature Language="DocId" Value="P:Azure.Communication.MicrosoftTeamsUserIdentifier.Cloud" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Cloud As CommunicationCloudEnvironment" />
<MemberSignature Language="F#" Value="member this.Cloud : Azure.Communication.CommunicationCloudEnvironment" Usage="Azure.Communication.MicrosoftTeamsUserIdentifier.Cloud" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Communication.Common</AssemblyName>
<AssemblyVersion>1.3.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Communication.CommunicationCloudEnvironment</ReturnType>
</ReturnValue>
<Docs>
<summary> The cloud that the identifier belongs to. </summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Equals">
<MemberSignature Language="C#" Value="public override bool Equals (Azure.Communication.CommunicationIdentifier other);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool Equals(class Azure.Communication.CommunicationIdentifier other) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Communication.MicrosoftTeamsUserIdentifier.Equals(Azure.Communication.CommunicationIdentifier)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function Equals (other As CommunicationIdentifier) As Boolean" />
<MemberSignature Language="F#" Value="override this.Equals : Azure.Communication.CommunicationIdentifier -> bool" Usage="microsoftTeamsUserIdentifier.Equals other" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Communication.Common</AssemblyName>
<AssemblyVersion>1.3.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="other" Type="Azure.Communication.CommunicationIdentifier" />
</Parameters>
<Docs>
<param name="other">An object to compare with this object.</param>
<summary>Indicates whether the current object is equal to another object of the same type.</summary>
<returns>
<see langword="true" /> if the current object is equal to the <paramref name="other" /> parameter; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="IsAnonymous">
<MemberSignature Language="C#" Value="public bool IsAnonymous { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool IsAnonymous" />
<MemberSignature Language="DocId" Value="P:Azure.Communication.MicrosoftTeamsUserIdentifier.IsAnonymous" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property IsAnonymous As Boolean" />
<MemberSignature Language="F#" Value="member this.IsAnonymous : bool" Usage="Azure.Communication.MicrosoftTeamsUserIdentifier.IsAnonymous" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Communication.Common</AssemblyName>
<AssemblyVersion>1.3.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>True if the user is anonymous, for example when joining a meeting with a share link.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="RawId">
<MemberSignature Language="C#" Value="public override string RawId { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string RawId" />
<MemberSignature Language="DocId" Value="P:Azure.Communication.MicrosoftTeamsUserIdentifier.RawId" />
<MemberSignature Language="VB.NET" Value="Public Overrides ReadOnly Property RawId As String" />
<MemberSignature Language="F#" Value="member this.RawId : string" Usage="Azure.Communication.MicrosoftTeamsUserIdentifier.RawId" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Communication.Common</AssemblyName>
<AssemblyVersion>1.3.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Returns the canonical string representation of the <see cref="T:Azure.Communication.MicrosoftTeamsUserIdentifier" />.
You can use the <see cref="P:Azure.Communication.MicrosoftTeamsUserIdentifier.RawId" /> for encoding the identifier and then use it as a key in a database.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ToString">
<MemberSignature Language="C#" Value="public override string ToString ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance string ToString() cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Communication.MicrosoftTeamsUserIdentifier.ToString" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function ToString () As String" />
<MemberSignature Language="F#" Value="override this.ToString : unit -> string" Usage="microsoftTeamsUserIdentifier.ToString " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Communication.Common</AssemblyName>
<AssemblyVersion>1.3.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Returns a string that represents the current object.</summary>
<returns>A string that represents the current object.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="UserId">
<MemberSignature Language="C#" Value="public string UserId { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string UserId" />
<MemberSignature Language="DocId" Value="P:Azure.Communication.MicrosoftTeamsUserIdentifier.UserId" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property UserId As String" />
<MemberSignature Language="F#" Value="member this.UserId : string" Usage="Azure.Communication.MicrosoftTeamsUserIdentifier.UserId" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Communication.Common</AssemblyName>
<AssemblyVersion>1.3.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>The id of the Microsoft Teams user. If the user isn't anonymous, the id is the Azure AD object id of the user.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>