-
Notifications
You must be signed in to change notification settings - Fork 261
/
NotificationHubConnectionStringBuilder.xml
154 lines (154 loc) · 7.95 KB
/
NotificationHubConnectionStringBuilder.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
<Type Name="NotificationHubConnectionStringBuilder" FullName="Microsoft.Azure.NotificationHubs.NotificationHubConnectionStringBuilder">
<TypeSignature Language="C#" Value="public class NotificationHubConnectionStringBuilder" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit NotificationHubConnectionStringBuilder extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.NotificationHubs.NotificationHubConnectionStringBuilder" />
<TypeSignature Language="VB.NET" Value="Public Class NotificationHubConnectionStringBuilder" />
<TypeSignature Language="F#" Value="type NotificationHubConnectionStringBuilder = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.NotificationHubs</AssemblyName>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
This class can be used to construct a connection string to be used
in creating messaging client entities. It can also be used to perform
basic validation on an existing connection string.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public NotificationHubConnectionStringBuilder (string connectionString);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string connectionString) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.NotificationHubs.NotificationHubConnectionStringBuilder.#ctor(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (connectionString As String)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.NotificationHubs.NotificationHubConnectionStringBuilder : string -> Microsoft.Azure.NotificationHubs.NotificationHubConnectionStringBuilder" Usage="new Microsoft.Azure.NotificationHubs.NotificationHubConnectionStringBuilder connectionString" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.NotificationHubs</AssemblyName>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="connectionString" Type="System.String" />
</Parameters>
<Docs>
<param name="connectionString">an connection string, which can be obtained
from azure management portal.</param>
<summary>
Create an instance of the connection builder using
an existing connection as a reference.
</summary>
<remarks>To be added.</remarks>
<list type="bullet">
<item>
<description>Connection string missing endpoints</description>
</item>
<item>
<description>Connection string does not have enough information for forming a token provider.
E.g. if user supplied a SasIssuer name but not a SasIssuer key.</description>
</item>
<item>
<description>OperationTimeout value is not a valid TimeSpan format</description>
</item>
<item>
<description>RuntimePort or ManagementPort value is not in an integer format</description>
</item>
</list>
</Docs>
</Member>
<Member MemberName="Endpoint">
<MemberSignature Language="C#" Value="public Uri Endpoint { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Uri Endpoint" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.NotificationHubs.NotificationHubConnectionStringBuilder.Endpoint" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Endpoint As Uri" />
<MemberSignature Language="F#" Value="member this.Endpoint : Uri" Usage="Microsoft.Azure.NotificationHubs.NotificationHubConnectionStringBuilder.Endpoint" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.NotificationHubs</AssemblyName>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Uri</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the collection of service endpoint. Each endpoint
must reference the same Notification Hubs namespace.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SharedAccessKey">
<MemberSignature Language="C#" Value="public string SharedAccessKey { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string SharedAccessKey" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.NotificationHubs.NotificationHubConnectionStringBuilder.SharedAccessKey" />
<MemberSignature Language="VB.NET" Value="Public Property SharedAccessKey As String" />
<MemberSignature Language="F#" Value="member this.SharedAccessKey : string with get, set" Usage="Microsoft.Azure.NotificationHubs.NotificationHubConnectionStringBuilder.SharedAccessKey" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.NotificationHubs</AssemblyName>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the access key for Sas token
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SharedAccessKeyName">
<MemberSignature Language="C#" Value="public string SharedAccessKeyName { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string SharedAccessKeyName" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.NotificationHubs.NotificationHubConnectionStringBuilder.SharedAccessKeyName" />
<MemberSignature Language="VB.NET" Value="Public Property SharedAccessKeyName As String" />
<MemberSignature Language="F#" Value="member this.SharedAccessKeyName : string with get, set" Usage="Microsoft.Azure.NotificationHubs.NotificationHubConnectionStringBuilder.SharedAccessKeyName" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.NotificationHubs</AssemblyName>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the key name for Sas token
</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:Microsoft.Azure.NotificationHubs.NotificationHubConnectionStringBuilder.ToString" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function ToString () As String" />
<MemberSignature Language="F#" Value="override this.ToString : unit -> string" Usage="notificationHubConnectionStringBuilder.ToString " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.NotificationHubs</AssemblyName>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Returns string representation of parsed connection string
</summary>
<returns />
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>