CrmConnectionManager CrmConnectionManager CrmConnectionManager CrmConnectionManager Class

Definition

Provides Connection logic and error handling for connecting to CRM2011. This class is designed to operate in the background, off the primary user UI thread. This class raises events that can be used to update the user with progress reports.

public ref class CrmConnectionManager : IDisposable
public class CrmConnectionManager : IDisposable
type CrmConnectionManager = class
    interface IDisposable
Public Class CrmConnectionManager
Implements IDisposable
Inheritance
CrmConnectionManagerCrmConnectionManagerCrmConnectionManagerCrmConnectionManager
Implements

Remarks

Constructors

CrmConnectionManager() CrmConnectionManager() CrmConnectionManager() CrmConnectionManager()

Default constructor.

Properties

ClientId ClientId ClientId ClientId

ConnectedOrgFriendlyName ConnectedOrgFriendlyName ConnectedOrgFriendlyName ConnectedOrgFriendlyName

Returns the friendly name of the connected org.

ConnectedOrgId ConnectedOrgId ConnectedOrgId ConnectedOrgId

ConnectedOrgPublishedEndpoints ConnectedOrgPublishedEndpoints ConnectedOrgPublishedEndpoints ConnectedOrgPublishedEndpoints

Returns the endpoint collection for the connected org.

ConnectedOrgUniqueName ConnectedOrgUniqueName ConnectedOrgUniqueName ConnectedOrgUniqueName

Returns the unique name for the org that has been connected.

CrmOnlineDiscoveryServerList CrmOnlineDiscoveryServerList CrmOnlineDiscoveryServerList CrmOnlineDiscoveryServerList

Collection of CRM Discovery Servers if a server list has not been submitted to this property, and get is called, a new instance of the CrmOnlineDiscoveryServers is created.

CrmOrgsFoundForUser CrmOrgsFoundForUser CrmOrgsFoundForUser CrmOrgsFoundForUser

List of Organizations that have been requested by the user.

CrmSvc CrmSvc CrmSvc CrmSvc

CRM Connection Object.

ForceFirstOAuthPrompt ForceFirstOAuthPrompt ForceFirstOAuthPrompt ForceFirstOAuthPrompt

HomeRealmServersList HomeRealmServersList HomeRealmServersList HomeRealmServersList

Collection of HomeRealms Loaded by Configuration

HostApplicatioNameOveride HostApplicatioNameOveride HostApplicatioNameOveride HostApplicatioNameOveride

Used in conjunction with the UseUserLocalDirecotryForConfigStore, Allows you to set a name for the config application to use. This is used when the host application cannot provide a proper AppDomain.Current.FriendlyName

LastError LastError LastError LastError

last error from the connection manager

LastException LastException LastException LastException

Last Exception from the connection manager.

ParentControl ParentControl ParentControl ParentControl

This the parent control that invoked me.

ProfileName ProfileName ProfileName ProfileName

Profile name to use for this login process.

RedirectUri RedirectUri RedirectUri RedirectUri

TokenCachePath TokenCachePath TokenCachePath TokenCachePath

UserId UserId UserId UserId

UseUserLocalDirectoryForConfigStore UseUserLocalDirectoryForConfigStore UseUserLocalDirectoryForConfigStore UseUserLocalDirectoryForConfigStore

Tells the system to store the user config in the users local app directory instead of the Exe directory.

Methods

CancelConnectToServerCheck() CancelConnectToServerCheck() CancelConnectToServerCheck() CancelConnectToServerCheck()

Cancel Connection process.

ConnectToServerCheck() ConnectToServerCheck() ConnectToServerCheck() ConnectToServerCheck()

Begins the authentication process for CRM.

ConnectToServerCheck(CrmOrgByServer) ConnectToServerCheck(CrmOrgByServer) ConnectToServerCheck(CrmOrgByServer) ConnectToServerCheck(CrmOrgByServer)

Begin Connect check to server

Dispose() Dispose() Dispose() Dispose()
Dispose(Boolean) Dispose(Boolean) Dispose(Boolean) Dispose(Boolean)
Finalize() Finalize() Finalize() Finalize()

Clean up background worker on exit.

LoadConfigFromFile(Boolean) LoadConfigFromFile(Boolean) LoadConfigFromFile(Boolean) LoadConfigFromFile(Boolean)

Loads the Configuration key's from file b/c some things are missing

RemoveUserLocalDirectoryConfigFile() RemoveUserLocalDirectoryConfigFile() RemoveUserLocalDirectoryConfigFile() RemoveUserLocalDirectoryConfigFile()

Will remove the user connection data settings from the users app config directory, useable only when the UseUserLocalDirectoryForConfigStore is set to true. this should be called after the connection has been established, or before the connect attempt in order to be effective.

RequireUserLogin() RequireUserLogin() RequireUserLogin() RequireUserLogin()

This will check the configuration to determine if a user login is required. and if so, return true.

SaveConfigToFile(Dictionary<Dynamics_ConfigFileServerKeys,Object>) SaveConfigToFile(Dictionary<Dynamics_ConfigFileServerKeys,Object>) SaveConfigToFile(Dictionary<Dynamics_ConfigFileServerKeys,Object>) SaveConfigToFile(Dictionary<Dynamics_ConfigFileServerKeys,Object>)

Save the configuration Keys to the configuration file.

SetConfigKeyInformation(Dictionary<Dynamics_ConfigFileServerKeys,Object>) SetConfigKeyInformation(Dictionary<Dynamics_ConfigFileServerKeys,Object>) SetConfigKeyInformation(Dictionary<Dynamics_ConfigFileServerKeys,Object>) SetConfigKeyInformation(Dictionary<Dynamics_ConfigFileServerKeys,Object>)

Sets the current connection information for the server.

this can be used to pass in a preconfigured list of keys

Events

ConnectionCheckComplete ConnectionCheckComplete ConnectionCheckComplete ConnectionCheckComplete

Raised when the connection process completes

ServerConnectionStatusUpdate ServerConnectionStatusUpdate ServerConnectionStatusUpdate ServerConnectionStatusUpdate

Raised when a status is updated

Applies to