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, CustomizeSyncCommandOptions options=null)
	Sends a command to the connector service.
void	SetServiceMode (Mode mode)
	Set (change) the service mode. This allows you to enable, disable or pause the connector service.
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.
bool	IsConnectorRegistered ()
	Test to see if the connector is registered or not.
void	UnregisterConnector ()
	Un-register a Cloud Connector for the service type from this computer.
void	UnregisterConnector (byte[] connectorGuid)
	Un-register a Cloud Connector for the service type from a different computer.
void	ResetConnectorSecret ()
	Manually reset the userid/secret used by the Cloud Connector Windows service.
IServiceInformation	GetServiceInformation ()
	Retrieves the service information for the organization.
void	SaveConnectorServiceUri (string uri)
	Save connector service uri.

Detailed Description

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

Member Function Documentation

GetServiceInformation()

IServiceInformation GetServiceInformation

(

)

Retrieves the service information for the organization.

Returns

A IServiceInformation interface.

Exceptions

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

Exceptions

ServiceException	Unspecified service error
Exception	Other exceptions may also be thrown by the platform and operating system

IsConnectorRegistered()

bool IsConnectorRegistered

(

)

Test to see if the connector is registered or not.

Returns

True if the connector is registered or false if not.

RegisterConnector()

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

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

Exceptions

ServiceException	Unspecified service error
Exception	Other exceptions may also be thrown by the platform and operating system

ResetConnectorSecret()

void ResetConnectorSecret

(

)

Manually reset the userid/secret used by the Cloud Connector Windows service.

Exceptions

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

Exceptions

ServiceException	Unspecified service error
Exception	Other exceptions may also be thrown by the platform and operating system

SaveConnectorServiceUri()

void SaveConnectorServiceUri

(

string

uri

)

Save connector service uri.

Parameters

uri

SendServiceCommand()

void SendServiceCommand	(	Command	command,
		CustomizeSyncCommandOptions	options = null )

Sends a command to the connector service.

Parameters

command

Command to send

Exceptions

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

Exceptions

ServiceException	Unspecified service error
Exception	Other exceptions may also be thrown by the platform and operating system

SetServiceMode()

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

mode	Mode to set

Exceptions

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

Exceptions

ServiceException	Unspecified service error
Exception	Other exceptions may also be thrown by the platform and operating system

UnregisterConnector() [1/2]

void UnregisterConnector

(

)

Un-register a Cloud Connector for the service type from this computer.

Exceptions

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

Exceptions

ServiceException	Unspecified service error
Exception	Other exceptions may also be thrown by the platform and operating system

UnregisterConnector() [2/2]

void UnregisterConnector

(

byte[]

connectorGuid

)

Un-register a Cloud Connector for the service type from a different computer.

Parameters

connectorGuid

GUID of computer to remove the service from

Exceptions

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

Exceptions

ServiceException	Unspecified service error
Exception	Other exceptions may also be thrown by the platform and operating system

---

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

• IServiceContext.cs