Share via


WebProxyClient<TService> Class

 

Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

A base class that creates an authenticated web service endpoint on a WCF channel.

Namespace:   Microsoft.Xrm.Sdk.WebServiceClient
Assembly:  Microsoft.Xrm.Sdk (in Microsoft.Xrm.Sdk.dll)

Inheritance Hierarchy

System.Object
  System.ServiceModel.ClientBase<TChannel>
    Microsoft.Xrm.Sdk.WebServiceClient.WebProxyClient<TService>
      Microsoft.Xrm.Sdk.WebServiceClient.DiscoveryWebProxyClient
      Microsoft.Xrm.Sdk.WebServiceClient.OrganizationWebProxyClient

Syntax

public abstract class WebProxyClient<TService> : ClientBase<TService>, 
    IDisposable
where TService : class
Public MustInherit Class WebProxyClient(Of TService As Class)
    Inherits ClientBase(Of TService)
    Implements IDisposable

Type Parameters

  • TService
    A type of web service.

Constructors

Name Description
System_CAPS_protmethod WebProxyClient<TService>(Uri, Assembly)

Initializes a new instance of theWebProxyClient<TService> class using an Organization service URL and an assembly.

System_CAPS_protmethod WebProxyClient<TService>(Uri, Boolean)

Initializes a new instance of theWebProxyClient<TService> class using an Organization service URL.

System_CAPS_protmethod WebProxyClient<TService>(Uri, TimeSpan, Assembly)

Initializes a new instance of theWebProxyClient<TService> class using an Organization service URL, a time span, and an assembly.

System_CAPS_protmethod WebProxyClient<TService>(Uri, TimeSpan, Boolean)

Initializes a new instance of theWebProxyClient<TService> class using an Organization service URL and time span.

Properties

Name Description
System_CAPS_protproperty Channel

(Inherited from ClientBase<TChannel>.)

System_CAPS_pubproperty ChannelFactory

(Inherited from ClientBase<TChannel>.)

System_CAPS_pubproperty ClientCredentials

(Inherited from ClientBase<TChannel>.)

System_CAPS_pubproperty Endpoint

(Inherited from ClientBase<TChannel>.)

System_CAPS_pubproperty HeaderToken

The access token returned from OAuth authentication.

System_CAPS_pubproperty InnerChannel

(Inherited from ClientBase<TChannel>.)

System_CAPS_pubproperty SdkClientVersion

The version of your client application.

System_CAPS_pubproperty State

(Inherited from ClientBase<TChannel>.)

Methods

Name Description
System_CAPS_pubmethod Abort()

(Inherited from ClientBase<TChannel>.)

System_CAPS_pubmethod Close()

(Inherited from ClientBase<TChannel>.)

System_CAPS_protmethod CreateChannel()

(Inherited from ClientBase<TChannel>.)

System_CAPS_protmethod CreateNewInitializer()

Creates the WCF proxy client initializer which gets invoked on every SDK method call. This method makes sure that the access token and other header values are added to the outbound call.

System_CAPS_protmethodSystem_CAPS_static CreateServiceEndpoint(Uri, Boolean, TimeSpan, Assembly)

Creates the service endpoint required for the proxy and adds support for early-bound types in the provided assembly.

System_CAPS_pubmethod DisplayInitializationUI()

(Inherited from ClientBase<TChannel>.)

System_CAPS_pubmethod Dispose()

Disposes the web proxy client object.

System_CAPS_protmethod Dispose(Boolean)

Disposes the web proxy client object.

System_CAPS_pubmethod Equals(Object)

(Inherited from Object.)

System_CAPS_protmethod Finalize()

Destructor for the WebProxyClient<TService> class.(Overrides Object.Finalize().)

System_CAPS_protmethodSystem_CAPS_static GetBinding(Uri, TimeSpan)

Returns the default BasicHttpBinding that the proxy classes will use.

System_CAPS_protmethod GetDefaultValueForInitialization<T>()

(Inherited from ClientBase<TChannel>.)

System_CAPS_pubmethod GetHashCode()

(Inherited from Object.)

System_CAPS_pubmethod GetType()

(Inherited from Object.)

System_CAPS_protmethod InvokeAsync(ClientBase<TChannel>.BeginOperationDelegate, Object[], ClientBase<TChannel>.EndOperationDelegate, SendOrPostCallback, Object)

(Inherited from ClientBase<TChannel>.)

System_CAPS_protmethod MemberwiseClone()

(Inherited from Object.)

System_CAPS_pubmethod Open()

(Inherited from ClientBase<TChannel>.)

System_CAPS_pubmethod ToString()

(Inherited from Object.)

Explicit Interface Implementations

Name Description
System_CAPS_pubinterfaceSystem_CAPS_privevent ICommunicationObject.Closed

(Inherited from ClientBase<TChannel>.)

System_CAPS_pubinterfaceSystem_CAPS_privevent ICommunicationObject.Closing

(Inherited from ClientBase<TChannel>.)

System_CAPS_pubinterfaceSystem_CAPS_privevent ICommunicationObject.Faulted

(Inherited from ClientBase<TChannel>.)

System_CAPS_pubinterfaceSystem_CAPS_privevent ICommunicationObject.Opened

(Inherited from ClientBase<TChannel>.)

System_CAPS_pubinterfaceSystem_CAPS_privevent ICommunicationObject.Opening

(Inherited from ClientBase<TChannel>.)

System_CAPS_pubinterfaceSystem_CAPS_privmethod IDisposable.Dispose()

(Inherited from ClientBase<TChannel>.)

System_CAPS_pubinterfaceSystem_CAPS_privmethod ICommunicationObject.BeginClose(AsyncCallback, Object)

(Inherited from ClientBase<TChannel>.)

System_CAPS_pubinterfaceSystem_CAPS_privmethod ICommunicationObject.BeginClose(TimeSpan, AsyncCallback, Object)

(Inherited from ClientBase<TChannel>.)

System_CAPS_pubinterfaceSystem_CAPS_privmethod ICommunicationObject.BeginOpen(AsyncCallback, Object)

(Inherited from ClientBase<TChannel>.)

System_CAPS_pubinterfaceSystem_CAPS_privmethod ICommunicationObject.BeginOpen(TimeSpan, AsyncCallback, Object)

(Inherited from ClientBase<TChannel>.)

System_CAPS_pubinterfaceSystem_CAPS_privmethod ICommunicationObject.Close(TimeSpan)

(Inherited from ClientBase<TChannel>.)

System_CAPS_pubinterfaceSystem_CAPS_privmethod ICommunicationObject.EndClose(IAsyncResult)

(Inherited from ClientBase<TChannel>.)

System_CAPS_pubinterfaceSystem_CAPS_privmethod ICommunicationObject.EndOpen(IAsyncResult)

(Inherited from ClientBase<TChannel>.)

System_CAPS_pubinterfaceSystem_CAPS_privmethod ICommunicationObject.Open(TimeSpan)

(Inherited from ClientBase<TChannel>.)

Thread Safety

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

DiscoveryWebProxyClient
OrganizationWebProxyClient
Microsoft.Xrm.Sdk.WebServiceClient Namespace

Return to top

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright