Permalink
Fetching contributors…
Cannot retrieve contributors at this time
390 lines (390 sloc) 20.7 KB
<Type Name="WebHttpRelayBinding" FullName="Microsoft.ServiceBus.WebHttpRelayBinding">
<TypeSignature Language="C#" Value="public class WebHttpRelayBinding : System.ServiceModel.Channels.Binding, System.ServiceModel.Channels.IBindingRuntimePreferences" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit WebHttpRelayBinding extends System.ServiceModel.Channels.Binding implements class System.ServiceModel.Channels.IBindingRuntimePreferences" />
<TypeSignature Language="DocId" Value="T:Microsoft.ServiceBus.WebHttpRelayBinding" />
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.ServiceModel.Channels.Binding</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>System.ServiceModel.Channels.IBindingRuntimePreferences</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<summary>A binding used to configure endpoints for Web services that are exposed through HTTP requests instead of SOAP messages. </summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public WebHttpRelayBinding ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.WebHttpRelayBinding.#ctor" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>Initializes a new instance of the <see cref="T:Microsoft.ServiceBus.WebHttpRelayBinding" /> class. </summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public WebHttpRelayBinding (string configurationName);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string configurationName) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.WebHttpRelayBinding.#ctor(System.String)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
</AssemblyInfo>
<Parameters>
<Parameter Name="configurationName" Type="System.String" />
</Parameters>
<Docs>
<param name="configurationName">The configuration to use.</param>
<summary>Initializes a new instance of the
<see cref="T:Microsoft.ServiceBus.WebHttpRelayBinding" /> class using the specified configuration name.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public WebHttpRelayBinding (Microsoft.ServiceBus.EndToEndWebHttpSecurityMode securityMode, Microsoft.ServiceBus.RelayClientAuthenticationType relayClientAuthenticationType);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype Microsoft.ServiceBus.EndToEndWebHttpSecurityMode securityMode, valuetype Microsoft.ServiceBus.RelayClientAuthenticationType relayClientAuthenticationType) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.WebHttpRelayBinding.#ctor(Microsoft.ServiceBus.EndToEndWebHttpSecurityMode,Microsoft.ServiceBus.RelayClientAuthenticationType)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
</AssemblyInfo>
<Parameters>
<Parameter Name="securityMode" Type="Microsoft.ServiceBus.EndToEndWebHttpSecurityMode" />
<Parameter Name="relayClientAuthenticationType" Type="Microsoft.ServiceBus.RelayClientAuthenticationType" />
</Parameters>
<Docs>
<param name="securityMode">The type of security used with the binding.</param>
<param name="relayClientAuthenticationType">The type of client authentication used on the relay. </param>
<summary>Initializes a new instance of the
<see cref="T:Microsoft.ServiceBus.WebHttpRelayBinding" /> class using the specified type of security and relay client authentication. </summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AllowCookies">
<MemberSignature Language="C#" Value="public bool AllowCookies { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool AllowCookies" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.WebHttpRelayBinding.AllowCookies" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets a value that specifies whether cookies are allowed in the messages sent via the
<see cref="T:Microsoft.ServiceBus.WebHttpRelayBinding" />.</summary>
<value>Returns true if cookies are allowed; otherwise, false. The default value is false.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ContentTypeMapper">
<MemberSignature Language="C#" Value="public System.ServiceModel.Channels.WebContentTypeMapper ContentTypeMapper { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.ServiceModel.Channels.WebContentTypeMapper ContentTypeMapper" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.WebHttpRelayBinding.ContentTypeMapper" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.ServiceModel.Channels.WebContentTypeMapper</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the content type mapper.</summary>
<value>The content type mapper.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CreateBindingElements">
<MemberSignature Language="C#" Value="public override System.ServiceModel.Channels.BindingElementCollection CreateBindingElements ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance class System.ServiceModel.Channels.BindingElementCollection CreateBindingElements() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.WebHttpRelayBinding.CreateBindingElements" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.ServiceModel.Channels.BindingElementCollection</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Creates a collection with the binding elements for the binding.</summary>
<returns>Returns a
<see cref="T:System.ServiceModel.Channels.BindingElementCollection" /> that contains the ordered stack of binding elements used by the
<see cref="T:Microsoft.ServiceBus.WebHttpRelayBinding" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="EnvelopeVersion">
<MemberSignature Language="C#" Value="public System.ServiceModel.EnvelopeVersion EnvelopeVersion { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.ServiceModel.EnvelopeVersion EnvelopeVersion" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.WebHttpRelayBinding.EnvelopeVersion" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.ServiceModel.EnvelopeVersion</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the SOAP envelope version. </summary>
<value>Returns a
<see cref="T:System.ServiceModel.EnvelopeVersion" />. Since the
<see cref="T:Microsoft.ServiceBus.WebHttpRelayBinding" /> does not use SOAP, this always returns EnvelopeVersion.None.<see cref="T:Microsoft.ServiceBus.WebHttpRelayBinding" /> is not likely the binding you should be using for SOAP messaging. However, Service Bus does support SOAP. </value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="HostNameComparisonMode">
<MemberSignature Language="C#" Value="public System.ServiceModel.HostNameComparisonMode HostNameComparisonMode { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.ServiceModel.HostNameComparisonMode HostNameComparisonMode" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.WebHttpRelayBinding.HostNameComparisonMode" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.ServiceModel.HostNameComparisonMode</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the comparison mode used on the host name.</summary>
<value>The comparison mode used on the host name.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="IsDynamic">
<MemberSignature Language="C#" Value="public bool IsDynamic { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool IsDynamic" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.WebHttpRelayBinding.IsDynamic" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets whether the relay binding is dynamic.</summary>
<value>true if the relay binding is dynamic; otherwise, false.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="MaxBufferPoolSize">
<MemberSignature Language="C#" Value="public long MaxBufferPoolSize { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int64 MaxBufferPoolSize" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.WebHttpRelayBinding.MaxBufferPoolSize" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the maximum buffer pool size used by the transport.</summary>
<value>Returns the maximum buffer pool size. The default is 524288 bytes.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="MaxBufferSize">
<MemberSignature Language="C#" Value="public int MaxBufferSize { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 MaxBufferSize" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.WebHttpRelayBinding.MaxBufferSize" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the maximum buffer size supported by the transport. </summary>
<value>Returns the max buffer size.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="MaxReceivedMessageSize">
<MemberSignature Language="C#" Value="public long MaxReceivedMessageSize { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int64 MaxReceivedMessageSize" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.WebHttpRelayBinding.MaxReceivedMessageSize" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the maximum allowable message size that can be received.</summary>
<value>Returns the maximum allowable message size. The default size is 65,536 bytes.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ProxyAddress">
<MemberSignature Language="C#" Value="public Uri ProxyAddress { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Uri ProxyAddress" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.WebHttpRelayBinding.ProxyAddress" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Uri</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets a URI that contains the address of the proxy to use for HTTP requests.</summary>
<value>Returns a <see cref="T:System.Uri" /> that contains the address of the proxy to use for HTTP requests. The default value is null.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ReaderQuotas">
<MemberSignature Language="C#" Value="public System.Xml.XmlDictionaryReaderQuotas ReaderQuotas { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Xml.XmlDictionaryReaderQuotas ReaderQuotas" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.WebHttpRelayBinding.ReaderQuotas" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Xml.XmlDictionaryReaderQuotas</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets xml reader quotas on the messages processed.</summary>
<value>Returns a <see cref="T:System.Xml.XmlDictionaryReaderQuotas" /> that contains the reader quotas.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Scheme">
<MemberSignature Language="C#" Value="public override string Scheme { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Scheme" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.WebHttpRelayBinding.Scheme" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the scheme for the endpoints used with the binding.</summary>
<value>Returns the scheme.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Security">
<MemberSignature Language="C#" Value="public Microsoft.ServiceBus.WebHttpRelaySecurity Security { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.ServiceBus.WebHttpRelaySecurity Security" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.WebHttpRelayBinding.Security" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.ServiceBus.WebHttpRelaySecurity</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the security settings for the current instance.</summary>
<value>Returns a <see cref="T:Microsoft.ServiceBus.WebHttpRelaySecurity" /> that contains the security settings.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="System.ServiceModel.Channels.IBindingRuntimePreferences.ReceiveSynchronously">
<MemberSignature Language="C#" Value="bool System.ServiceModel.Channels.IBindingRuntimePreferences.ReceiveSynchronously { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool System.ServiceModel.Channels.IBindingRuntimePreferences.ReceiveSynchronously" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.WebHttpRelayBinding.System#ServiceModel#Channels#IBindingRuntimePreferences#ReceiveSynchronously" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="TransferMode">
<MemberSignature Language="C#" Value="public System.ServiceModel.TransferMode TransferMode { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.ServiceModel.TransferMode TransferMode" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.WebHttpRelayBinding.TransferMode" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.ServiceModel.TransferMode</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the transfer mode.</summary>
<value>Returns a <see cref="T:System.ServiceModel.TransferMode" /> that contains the transfer mode. The default is Buffered.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="UseDefaultWebProxy">
<MemberSignature Language="C#" Value="public bool UseDefaultWebProxy { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool UseDefaultWebProxy" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.WebHttpRelayBinding.UseDefaultWebProxy" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets a value that indicates whether the machine-wide proxy settings are used rather than the user specific settings.</summary>
<value>true if machine-wide proxy settings are used. Otherwise false. The default setting is true.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="WriteEncoding">
<MemberSignature Language="C#" Value="public System.Text.Encoding WriteEncoding { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Text.Encoding WriteEncoding" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.WebHttpRelayBinding.WriteEncoding" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Text.Encoding</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the character encoding that is used to write the message text.</summary>
<value>Returns a <see cref="T:System.Text.Encoding" /> that contains the encoding. The default value is utf8encoding.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>