OrganizationWebProxyClient Class

Article
11/28/2016

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

Implements IOrganizationService and provides an authenticated connection to the Organization.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.OrganizationWebProxyClient

Syntax

public class OrganizationWebProxyClient : WebProxyClient<IOrganizationService>, 
    IOrganizationService

Public Class OrganizationWebProxyClient
    Inherits WebProxyClient(Of IOrganizationService)
    Implements IOrganizationService

Constructors

	Name	Description
	OrganizationWebProxyClient(Uri, Assembly)	Initializes a new instance of theOrganizationWebProxyClient class using an Organization service URL and an assembly.
	OrganizationWebProxyClient(Uri, Boolean)	Initializes a new instance of theOrganizationWebProxyClient class using an Organization service URL.
	OrganizationWebProxyClient(Uri, TimeSpan, Assembly)	Initializes a new instance of theOrganizationWebProxyClient class using an Organization service URL, a time span, and an assembly.
	OrganizationWebProxyClient(Uri, TimeSpan, Boolean)	Initializes a new instance of theOrganizationWebProxyClient class using an Organization service URL and time span.

Properties

	Name	Description
	CallerId	Gets or sets the ID of the user for whom SDK calls are made on behalf of.
	CallerRegardingObjectId
	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>.)
	SyncOperationType	For internal use only.
	userType

Methods

	Name	Description
	Abort()	(Inherited from ClientBase<TChannel>.)
	Associate(String, Guid, Relationship, EntityReferenceCollection)	Creates a link between records.
	AssociateCore(String, Guid, Relationship, EntityReferenceCollection)	For internal use only.
	Close()	(Inherited from ClientBase<TChannel>.)
	Create(Entity)	Creates a record.
	CreateChannel()	(Inherited from ClientBase<TChannel>.)
	CreateCore(Entity)	For internal use only.
	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().)
	Delete(String, Guid)	Deletes a record.
	DeleteCore(String, Guid)	For internal use only.
	Disassociate(String, Guid, Relationship, EntityReferenceCollection)	Deletes a link between records.
	DisassociateCore(String, Guid, Relationship, EntityReferenceCollection)	For internal use only.
	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(OrganizationRequest)	Executes a message in the form of a request, and returns a response.
	ExecuteCore(OrganizationRequest)	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>.)
	Retrieve(String, Guid, ColumnSet)	Retrieves a record.
	RetrieveCore(String, Guid, ColumnSet)	For internal use only.
	RetrieveMultiple(QueryBase)	Retrieves a collection of records.
	RetrieveMultipleCore(QueryBase)	For internal use only.
	ToString()	(Inherited from Object.)
	Update(Entity)	Updates an existing record.
	UpdateCore(Entity)	For internal use only.

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 Organization web service using the IOrganizationService interface, cast the proxy instance to an IOrganizationService 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.