ServiceProxy Members

Provides an abstract base class to encapsulate service connection operations and user authentication management.

The following tables list the members exposed by the ServiceProxy type.

Protected Constructors

  Name Description
  ServiceProxy Overloaded. Initializes a new instance of the ServiceProxy class.

Top

Public Properties

(see also Protected Properties)

  Name Description
public property ClientCredentials Gets the login credentials of the client.
public property DeviceCredentials Gets the Windows Live credentials of a registered device.
public property EndpointAutoSwitchEnabled Gets or sets a value that enables automatic switching from the organization’s current endpoint to an alternate endpoint.
public property EndpointSwitch Gets the endpoint switch information from the web service configuration.
public property HomeRealmSecurityTokenResponse Gets the security token response of the home realm.
public property HomeRealmUri Gets the home realm URI.
public property IsAuthenticated Gets a value indicating if the WCF channel has been authenticated.
public property SecurityTokenResponse Gets the security token response.
public property ServiceChannel Gets the communication channel used to access a Microsoft Dynamics CRM service.
public property ServiceConfiguration Gets a service configuration.
public property ServiceManagement Gets a service management.
public property Timeout Gets or sets the maximum amount of time a single channel operation has to complete before a timeout fault is raised on a service channel binding.
public property UserPrincipalName Gets or sets the UPN that is an Internet-style login name for a user based on the Internet standard RFC 822.

Top

Protected Properties

  Name Description
protected property ChannelFactory Gets a WCF channel factory that manages a single channel instance.

Top

Public Methods

(see also Protected Methods)

  Name Description
public method Authenticate Closes the service channel and channel factory if they are open, and then invokes AuthenticateCore.
public method AuthenticateCrossRealm Invokes AuthenticateCrossRealmCore.
public method AuthenticateDevice Invokes AuthenticateDeviceCore.
public method Dispose Overloaded. Methods that explicitly free allocated service channel resources.
public method Equals  (inherited from Object)
public method GetHashCode  (inherited from Object)
public method GetType  (inherited from Object)
public method SwitchToAlternateEndpoint Switches the organization’s current endpoint to an alternate endpoint, if one is available.
public method ToString  (inherited from Object)

Top

Protected Methods

  Name Description
protected method AuthenticateCore Authenticates the client with a service.
protected method AuthenticateCrossRealmCore Authenticates a user in a realm other than the realm that the Microsoft Dynamics CRM server is located in.
protected method AuthenticateDeviceCore Authenticates a device with Windows Live.
protected method CloseChannel Closes a validated service channel.
protected method Dispose Overloaded. Methods that explicitly free allocated service channel resources.
protected method Finalize Overridden. Implicitly frees allocated service channel and service factory resources.
protected method HandleFailover Overloaded. For internal use only.
protected method MemberwiseClone  (inherited from Object)
protected method OnFactoryClosed Event handler virtual method for a channel factory that is in a closed state.
protected method OnFactoryFaulted Event handler virtual method for a channel factory that is in a faulted state.
protected method OnFactoryOpened Event handler virtual method for a channel factory that is in an opened state.
protected method static SetBindingTimeout The maximum amount of time a single channel operation has to complete before a timeout fault is raised on a service channel binding.
protected method ShouldRetry Checks a message security exception to determine if a service call should be attempted again.
protected method ValidateAuthentication Authenticates the client and creates a new service channel.

Top

Public Events

  Name Description
public event EndpointSwitched Occurs when a failover recovery has completed and the organization’s current endpoint has been switched to an alternate endpoint.
public event EndpointSwitchRequired Occurs when a failover has occurred and a switch from the organization’s current endpoint to an alternate endpoint is required.
public event FactoryClosed Occurs when a channel factory is closed.
public event FactoryFaulted Occurs when a channel factory is faulted.
public event FactoryOpened Occurs when a channel factory is opened.

Top

See Also

Reference

ServiceProxy Generic Class
Microsoft.Xrm.Sdk.Client Namespace

Other Resources

Active Directory and Claims-Based Authentication

Send comments about this topic to Microsoft.
© 2015 Microsoft. All rights reserved.