CrmConnectionManager Class

 

Updated: November 29, 2016

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

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.

Namespace:   Microsoft.Xrm.Tooling.CrmConnectControl
Assembly:  Microsoft.Xrm.Tooling.CrmConnectControl (in Microsoft.Xrm.Tooling.CrmConnectControl.dll)

System.Object
  Microsoft.Xrm.Tooling.CrmConnectControl.CrmConnectionManager

public class CrmConnectionManager

NameDescription
System_CAPS_pubmethodCrmConnectionManager()

Default constructor.

NameDescription
System_CAPS_pubpropertyClientId

System_CAPS_pubpropertyConnectedOrgFriendlyName

Returns the friendly name of the connected org.

System_CAPS_pubpropertyConnectedOrgId

System_CAPS_pubpropertyConnectedOrgPublishedEndpoints

Returns the endpoint collection for the connected org.

System_CAPS_pubpropertyConnectedOrgUniqueName

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

System_CAPS_pubpropertyCrmOnlineDiscoveryServerList

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.

System_CAPS_pubpropertyCrmOrgsFoundForUser

List of Organizations that have been requested by the user.

System_CAPS_pubpropertyCrmSvc

CRM Connection Object.

System_CAPS_pubpropertyForceFirstOAuthPrompt

System_CAPS_pubpropertyHomeRealmServersList

Collection of HomeRealms Loaded by Configuration

System_CAPS_pubpropertyHostApplicatioNameOveride

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

System_CAPS_pubpropertyLastError

last error from the connection manager

System_CAPS_pubpropertyLastException

Last Exception from the connection manager.

System_CAPS_pubpropertyParentControl

This the parent control that invoked me.

System_CAPS_pubpropertyProfileName

Profile name to use for this login process.

System_CAPS_pubpropertyRedirectUri

System_CAPS_pubpropertyTokenCachePath

System_CAPS_pubpropertyUserId

System_CAPS_pubpropertyUseUserLocalDirectoryForConfigStore

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

NameDescription
System_CAPS_pubmethodCancelConnectToServerCheck()

Cancel Connection process.

System_CAPS_pubmethodConnectToServerCheck()

Begins the authentication process for CRM.

System_CAPS_pubmethodConnectToServerCheck(CrmOrgByServer)

Begin Connect check to server

System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_protmethodFinalize()

Clean up background worker on exit.(Overrides Object.Finalize().)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodLoadConfigFromFile(Boolean)

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

System_CAPS_protmethodMemberwiseClone()

(Inherited from Object.)

System_CAPS_pubmethodRemoveUserLocalDirectoryConfigFile()

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.

System_CAPS_pubmethodRequireUserLogin()

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

System_CAPS_pubmethodSaveConfigToFile(Dictionary<Dynamics_ConfigFileServerKeys, Object>)

Save the configuration Keys to the configuration file.

System_CAPS_pubmethodSetConfigKeyInformation(Dictionary<Dynamics_ConfigFileServerKeys, Object>)

Sets the current connection information for the server.

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

System_CAPS_pubmethodToString()

(Inherited from Object.)

NameDescription
System_CAPS_pubeventConnectionCheckComplete

Raised when the connection process completes

System_CAPS_pubeventServerConnectionStatusUpdate

Raised when a status is updated

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

Return to top

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright

Community Additions

ADD
Show: