Cloud Connector API
version 3.5.1001.64485
API for managing and configuring the Cloud Connector
|
Context for sending actions to the connector service for a service type. More...
Public Member Functions | |
void | SendServiceCommand (Command command) |
Sends a command to the connector service. More... | |
void | SetServiceMode (Mode mode) |
Set (change) the service mode. This allows you to enable, disable or pause the connector service. More... | |
void | RegisterConnector (ISyncDomain boundDomain) |
Register a Cloud Connector for the service type on this computer. This will "bind" the Connector to the current organization if it isn't already bound. The connector cannot be bound to a different organization. More... | |
bool | IsConnectorRegistered () |
Test to see if the connector is registered or not. More... | |
void | UnregisterConnector () |
Un-register a Cloud Connector for the service type from this computer. More... | |
void | UnregisterConnector (byte[] connectorGuid) |
Un-register a Cloud Connector for the service type from a different computer. More... | |
void | ResetConnectorSecret () |
Manually reset the userid/secret used by the Cloud Connector Windows service. More... | |
IServiceInformation | GetServiceInformation () |
Retrieves the service information for the organization. More... | |
void | SaveConnectorServiceUri (string uri) |
Save connector service uri. More... | |
Context for sending actions to the connector service for a service type.
IServiceInformation GetServiceInformation | ( | ) |
Retrieves the service information for the organization.
PermissionDeniedException | The user does not have enough permissions |
ServiceFailureException | Get service information failed |
NoSuchOrganizationException | The organization does not exist |
SessionExpiredException | The session to the Connector Service has expired |
ServiceException | Unspecified service error |
Exception | Other exceptions may also be thrown by the platform and operating system |
bool IsConnectorRegistered | ( | ) |
Test to see if the connector is registered or not.
void RegisterConnector | ( | ISyncDomain | boundDomain | ) |
Register a Cloud Connector for the service type on this computer. This will "bind" the Connector to the current organization if it isn't already bound. The connector cannot be bound to a different organization.
InvalidOperationException | The Connector is already bound to a different organization |
PermissionDeniedException | The user does not have enough permissions |
ServiceFailureException | RegisterConnector failed |
NoSuchOrganizationException | The organization does not exist |
SessionExpiredException | The session to the Connector Service has expired |
ServiceException | Unspecified service error |
Exception | Other exceptions may also be thrown by the platform and operating system |
void ResetConnectorSecret | ( | ) |
Manually reset the userid/secret used by the Cloud Connector Windows service.
PermissionDeniedException | The user does not have enough permissions |
ServiceFailureException | Reset secret failed |
NoSuchOrganizationException | The organization does not exist |
SessionExpiredException | The session to the Connector Service has expired |
ServiceException | Unspecified service error |
Exception | Other exceptions may also be thrown by the platform and operating system |
void SaveConnectorServiceUri | ( | string | uri | ) |
Save connector service uri.
uri |
void SendServiceCommand | ( | Command | command | ) |
Sends a command to the connector service.
command | Command to send |
PermissionDeniedException | The user does not have enough permissions |
ServiceFailureException | SendServiceCommand failed |
NoSuchOrganizationException | The organization does not exist |
SessionExpiredException | The session to the Connector Service has expired |
ServiceException | Unspecified service error |
Exception | Other exceptions may also be thrown by the platform and operating system |
void SetServiceMode | ( | Mode | mode | ) |
Set (change) the service mode. This allows you to enable, disable or pause the connector service.
Changing mode to/from disabled should be done with care!
mode | Mode to set |
PermissionDeniedException | The user does not have enough permissions |
ServiceFailureException | SetServiceMode failed |
NoSuchOrganizationException | The organization does not exist |
SessionExpiredException | The session to the Connector Service has expired |
ServiceException | Unspecified service error |
Exception | Other exceptions may also be thrown by the platform and operating system |
void UnregisterConnector | ( | ) |
Un-register a Cloud Connector for the service type from this computer.
PermissionDeniedException | The user does not have enough permissions |
ServiceFailureException | UnregisterConnector failed |
NoSuchOrganizationException | The organization does not exist |
SessionExpiredException | The session to the Connector Service has expired |
ServiceException | Unspecified service error |
Exception | Other exceptions may also be thrown by the platform and operating system |
void UnregisterConnector | ( | byte[] | connectorGuid | ) |
Un-register a Cloud Connector for the service type from a different computer.
connectorGuid | GUID of computer to remove the service from |
PermissionDeniedException | The user does not have enough permissions |
ServiceFailureException | UnregisterConnector failed |
NoSuchOrganizationException | The organization does not exist |
SessionExpiredException | The session to the Connector Service has expired |
ServiceException | Unspecified service error |
Exception | Other exceptions may also be thrown by the platform and operating system |