DiscoveryWebProxyClient Class

Article
11/28/2016

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

Implements IDiscoveryService and provides an authenticated connection to the Discovery.svc/web endpoint. This /web endpoint is also used by web resources.

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

Syntax

public class DiscoveryWebProxyClient : WebProxyClient<IDiscoveryService>, 
    IDiscoveryService

Public Class DiscoveryWebProxyClient
    Inherits WebProxyClient(Of IDiscoveryService)
    Implements IDiscoveryService

Constructors

	Name	Description
	DiscoveryWebProxyClient(Uri)	Initializes a new instance of theDiscoveryWebProxyClient class using a Discovery service URL.
	DiscoveryWebProxyClient(Uri, TimeSpan)	Initializes a new instance of theDiscoveryWebProxyClient class using a Discovery service URL and a time span.

Properties

	Name	Description
	Channel	(Inherited from ClientBase<TChannel>.)
	ChannelFactory	(Inherited from ClientBase<TChannel>.)
	ClientCredentials	(Inherited from ClientBase<TChannel>.)
	Endpoint	(Inherited from ClientBase<TChannel>.)
	HeaderToken	The access token returned from OAuth authentication.(Inherited from WebProxyClient<TService>.)
	InnerChannel	(Inherited from ClientBase<TChannel>.)
	SdkClientVersion	The version of your client application.(Inherited from WebProxyClient<TService>.)
	State	(Inherited from ClientBase<TChannel>.)

Methods

	Name	Description
	Abort()	(Inherited from ClientBase<TChannel>.)
	Close()	(Inherited from ClientBase<TChannel>.)
	CreateChannel()	(Inherited from ClientBase<TChannel>.)
	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.(Overrides WebProxyClient<TService>.CreateNewInitializer().)
	DisplayInitializationUI()	(Inherited from ClientBase<TChannel>.)
	Dispose()	Disposes the web proxy client object.(Inherited from WebProxyClient<TService>.)
	Dispose(Boolean)	Disposes the web proxy client object.(Inherited from WebProxyClient<TService>.)
	Equals(Object)	(Inherited from Object.)
	Execute(DiscoveryRequest)
	ExecuteCore(DiscoveryRequest)	For internal use only.
	Finalize()	Destructor for the WebProxyClient<TService> class.(Inherited from WebProxyClient<TService>.)
	GetDefaultValueForInitialization<T>()	(Inherited from ClientBase<TChannel>.)
	GetHashCode()	(Inherited from Object.)
	GetType()	(Inherited from Object.)
	InvokeAsync(ClientBase<TChannel>.BeginOperationDelegate, Object[], ClientBase<TChannel>.EndOperationDelegate, SendOrPostCallback, Object)	(Inherited from ClientBase<TChannel>.)
	MemberwiseClone()	(Inherited from Object.)
	Open()	(Inherited from ClientBase<TChannel>.)
	ToString()	(Inherited from Object.)

Explicit Interface Implementations

	Name	Description
	ICommunicationObject.Closed	(Inherited from ClientBase<TChannel>.)
	ICommunicationObject.Closing	(Inherited from ClientBase<TChannel>.)
	ICommunicationObject.Faulted	(Inherited from ClientBase<TChannel>.)
	ICommunicationObject.Opened	(Inherited from ClientBase<TChannel>.)
	ICommunicationObject.Opening	(Inherited from ClientBase<TChannel>.)
	IDisposable.Dispose()	(Inherited from ClientBase<TChannel>.)
	ICommunicationObject.BeginClose(AsyncCallback, Object)	(Inherited from ClientBase<TChannel>.)
	ICommunicationObject.BeginClose(TimeSpan, AsyncCallback, Object)	(Inherited from ClientBase<TChannel>.)
	ICommunicationObject.BeginOpen(AsyncCallback, Object)	(Inherited from ClientBase<TChannel>.)
	ICommunicationObject.BeginOpen(TimeSpan, AsyncCallback, Object)	(Inherited from ClientBase<TChannel>.)
	ICommunicationObject.Close(TimeSpan)	(Inherited from ClientBase<TChannel>.)
	ICommunicationObject.EndClose(IAsyncResult)	(Inherited from ClientBase<TChannel>.)
	ICommunicationObject.EndOpen(IAsyncResult)	(Inherited from ClientBase<TChannel>.)
	ICommunicationObject.Open(TimeSpan)	(Inherited from ClientBase<TChannel>.)

Remarks

You must set the HeaderToken and SdkClientVersion property values before using the proxy object to make service calls.

To call the Discovery web service using the IDiscoveryService interface, cast the proxy instance to an IDiscoveryService type.

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.

Share via