-
Notifications
You must be signed in to change notification settings - Fork 24
/
ConferenceCommandOptions.xml
115 lines (115 loc) · 6.81 KB
/
ConferenceCommandOptions.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
<Type Name="ConferenceCommandOptions" FullName="Microsoft.Rtc.Collaboration.ConferenceCommandOptions">
<TypeSignature Language="C#" Value="public abstract class ConferenceCommandOptions" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit ConferenceCommandOptions extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Rtc.Collaboration.ConferenceCommandOptions" />
<TypeSignature Language="VB.NET" Value="Public MustInherit Class ConferenceCommandOptions" />
<TypeSignature Language="C++ CLI" Value="public ref class ConferenceCommandOptions abstract" />
<TypeSignature Language="F#" Value="type ConferenceCommandOptions = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Represents common options that an application can set to customize a specific conference command.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected ConferenceCommandOptions ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Rtc.Collaboration.ConferenceCommandOptions.#ctor" />
<MemberSignature Language="VB.NET" Value="Protected Sub New ()" />
<MemberSignature Language="C++ CLI" Value="protected:
 ConferenceCommandOptions();" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>
Constructs the object.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Headers">
<MemberSignature Language="C#" Value="public System.Collections.ObjectModel.Collection<Microsoft.Rtc.Signaling.SignalingHeader> Headers { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.ObjectModel.Collection`1<class Microsoft.Rtc.Signaling.SignalingHeader> Headers" />
<MemberSignature Language="DocId" Value="P:Microsoft.Rtc.Collaboration.ConferenceCommandOptions.Headers" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Headers As Collection(Of SignalingHeader)" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::Collections::ObjectModel::Collection<Microsoft::Rtc::Signaling::SignalingHeader ^> ^ Headers { System::Collections::ObjectModel::Collection<Microsoft::Rtc::Signaling::SignalingHeader ^> ^ get(); };" />
<MemberSignature Language="F#" Value="member this.Headers : System.Collections.ObjectModel.Collection<Microsoft.Rtc.Signaling.SignalingHeader>" Usage="Microsoft.Rtc.Collaboration.ConferenceCommandOptions.Headers" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.ObjectModel.Collection<Microsoft.Rtc.Signaling.SignalingHeader></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the list of custom headers to be included in the outgoing command.
</summary>
<value>To be added.</value>
<remarks>
<para>
Applications should not add any restricted headers including contact header to this list.
</para>
<para />
</remarks>
</Docs>
</Member>
<Member MemberName="Issuer">
<MemberSignature Language="C#" Value="public Microsoft.Rtc.Collaboration.ConversationParticipant Issuer { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Rtc.Collaboration.ConversationParticipant Issuer" />
<MemberSignature Language="DocId" Value="P:Microsoft.Rtc.Collaboration.ConferenceCommandOptions.Issuer" />
<MemberSignature Language="VB.NET" Value="Public Property Issuer As ConversationParticipant" />
<MemberSignature Language="C++ CLI" Value="public:
 property Microsoft::Rtc::Collaboration::ConversationParticipant ^ Issuer { Microsoft::Rtc::Collaboration::ConversationParticipant ^ get(); void set(Microsoft::Rtc::Collaboration::ConversationParticipant ^ value); };" />
<MemberSignature Language="F#" Value="member this.Issuer : Microsoft.Rtc.Collaboration.ConversationParticipant with get, set" Usage="Microsoft.Rtc.Collaboration.ConferenceCommandOptions.Issuer" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Rtc.Collaboration.ConversationParticipant</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the issuer of the command.
</summary>
<value>To be added.</value>
<remarks>
<para>
Trusted applications can issue commands within the context of other conference users who are connected
to the conference (either connected to the focus or to the MCU with one or more modalities).
</para>
<para>
As an example, a PSTN user connected to the audio-video MCU is unable to issue any commands to the focus.
However, a trusted application such as the personal virtual assistant (PVA) can issue commands within
the context of that PSTN user to the focus. The focus will execute this command within the authorization
context of that PSTN user.
</para>
<para>
Setting this property is recommended when the trusted application is executing commands in the context of
other users to avoid any elevation of privilege.
</para>
<para>
In order to issue a command within the context of another conference user, the application must join the conference
as a trusted application. This requires an application endpoint to be established with a trusted service GRUU. Additionally,
the conversation should join the conference as a trusted application by setting <see cref="P:Microsoft.Rtc.Collaboration.ConferenceJoinOptions.JoinMode" /> to <see cref="F:Microsoft.Rtc.Collaboration.JoinMode.TrustedParticipant" />.
</para>
<para />
</remarks>
</Docs>
</Member>
</Members>
</Type>