Cloud Connector API  version 3.5.1001.64485
API for managing and configuring the Cloud Connector
IServiceContext Interface Reference

Context for sending actions to the connector service for a service type. More...

+ Inheritance diagram for IServiceContext:

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...
 

Detailed Description

Context for sending actions to the connector service for a service type.

Member Function Documentation

IServiceInformation GetServiceInformation ( )

Retrieves the service information for the organization.

Returns
A IServiceInformation interface.
Exceptions
PermissionDeniedExceptionThe user does not have enough permissions
ServiceFailureExceptionGet service information failed
NoSuchOrganizationExceptionThe organization does not exist
SessionExpiredExceptionThe session to the Connector Service has expired
ServiceExceptionUnspecified service error
ExceptionOther exceptions may also be thrown by the platform and operating system
bool IsConnectorRegistered ( )

Test to see if the connector is registered or not.

Returns
True if the connector is registered or false if 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.

Exceptions
InvalidOperationExceptionThe Connector is already bound to a different organization
PermissionDeniedExceptionThe user does not have enough permissions
ServiceFailureExceptionRegisterConnector failed
NoSuchOrganizationExceptionThe organization does not exist
SessionExpiredExceptionThe session to the Connector Service has expired
ServiceExceptionUnspecified service error
ExceptionOther 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.

Exceptions
PermissionDeniedExceptionThe user does not have enough permissions
ServiceFailureExceptionReset secret failed
NoSuchOrganizationExceptionThe organization does not exist
SessionExpiredExceptionThe session to the Connector Service has expired
ServiceExceptionUnspecified service error
ExceptionOther exceptions may also be thrown by the platform and operating system
void SaveConnectorServiceUri ( string  uri)

Save connector service uri.

Parameters
uri
void SendServiceCommand ( Command  command)

Sends a command to the connector service.

Parameters
commandCommand to send
Exceptions
PermissionDeniedExceptionThe user does not have enough permissions
ServiceFailureExceptionSendServiceCommand failed
NoSuchOrganizationExceptionThe organization does not exist
SessionExpiredExceptionThe session to the Connector Service has expired
ServiceExceptionUnspecified service error
ExceptionOther 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!

Parameters
modeMode to set
Exceptions
PermissionDeniedExceptionThe user does not have enough permissions
ServiceFailureExceptionSetServiceMode failed
NoSuchOrganizationExceptionThe organization does not exist
SessionExpiredExceptionThe session to the Connector Service has expired
ServiceExceptionUnspecified service error
ExceptionOther 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.

Exceptions
PermissionDeniedExceptionThe user does not have enough permissions
ServiceFailureExceptionUnregisterConnector failed
NoSuchOrganizationExceptionThe organization does not exist
SessionExpiredExceptionThe session to the Connector Service has expired
ServiceExceptionUnspecified service error
ExceptionOther 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.

Parameters
connectorGuidGUID of computer to remove the service from
Exceptions
PermissionDeniedExceptionThe user does not have enough permissions
ServiceFailureExceptionUnregisterConnector failed
NoSuchOrganizationExceptionThe organization does not exist
SessionExpiredExceptionThe session to the Connector Service has expired
ServiceExceptionUnspecified service error
ExceptionOther exceptions may also be thrown by the platform and operating system

The documentation for this interface was generated from the following file: