Class ReplicationAgent

Facade for the Replication Agent Replication/Travel administration

Online Restricted: This agent is not available in Online by default. Not available in Online. Only used on-site.

Inheritance

Object

AgentBase<IReplicationAgent>

ReplicationAgent

Implements

IDisposable

IReplicationAgent

IAgent

Inherited Members

AgentBase<IReplicationAgent>.Dispose()

AgentBase<IReplicationAgent>.InnerAgent

Namespace: SuperOffice.CRM.Services

Assembly: SuperOffice.Services.dll

Syntax

public class ReplicationAgent : AgentBase<IReplicationAgent>, IDisposable, IReplicationAgent, IAgent

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ReplicationAgent agent = new ReplicationAgent())
     {
        // call methods on agent here...
     }
  }

Constructors

ReplicationAgent()

Facade for the Replication Agent Replication/Travel administration

Online Restricted: This agent is not available in Online by default. Not available in Online. Only used on-site.

Declaration

public ReplicationAgent()

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ReplicationAgent agent = new ReplicationAgent())
     {
        // call methods on agent here...
     }
  }

Methods

CreateDefaultSatellite()

Loading default values into a new Satellite. NetServer calculates default values (e.g. Country) on the entity, which is required when creating/storing a new instance

Declaration

public Satellite CreateDefaultSatellite()

Returns

Type	Description
Satellite	New Satellite with default values

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ReplicationAgent agent = new ReplicationAgent())
     {
        // call methods on agent here...
     }
  }

GetArea(Int32)

Gets a Area object.

Declaration

public Area GetArea(int areaId)

Parameters

Type	Name	Description
Int32	areaId	The identifier of the Area object

Returns

Type	Description
Area	Area

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ReplicationAgent agent = new ReplicationAgent())
     {
        // call methods on agent here...
     }
  }

GetAreaList(Int32[])

Gets an array of Area objects.

Declaration

public Area[] GetAreaList(int[] areaIds)

Parameters

Type	Name	Description
Int32[]	areaIds	The identifiers of the Area object

Returns

Type	Description
Area[]	Array of Area objects

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ReplicationAgent agent = new ReplicationAgent())
     {
        // call methods on agent here...
     }
  }

GetCentralLicense()

Facade for the Replication Agent Replication/Travel administration

Online Restricted: This agent is not available in Online by default. Not available in Online. Only used on-site.

Declaration

public LicenseOwner[] GetCentralLicense()

Returns

Type	Description
LicenseOwner[]

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ReplicationAgent agent = new ReplicationAgent())
     {
        // call methods on agent here...
     }
  }

GetSatellite(Int32)

Gets a Satellite object.

Declaration

public Satellite GetSatellite(int satelliteId)

Parameters

Type	Name	Description
Int32	satelliteId	The identifier of the Satellite object

Returns

Type	Description
Satellite	Satellite

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ReplicationAgent agent = new ReplicationAgent())
     {
        // call methods on agent here...
     }
  }

SaveCentralLicense(LicenseOwner[])

Facade for the Replication Agent Replication/Travel administration

Online Restricted: This agent is not available in Online by default. Not available in Online. Only used on-site.

Declaration

public LicenseOwner[] SaveCentralLicense(LicenseOwner[] license)

Parameters

Type	Name	Description
LicenseOwner[]	license

Returns

Type	Description
LicenseOwner[]

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ReplicationAgent agent = new ReplicationAgent())
     {
        // call methods on agent here...
     }
  }

SaveSatellite(Satellite)

Updates the existing Satellite or creates a new Satellite if the id parameter is empty

Declaration

public Satellite SaveSatellite(Satellite satellite)

Parameters

Type	Name	Description
Satellite	satellite	The Satellite that is saved.

Returns

Type	Description
Satellite	New or updated Satellite

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ReplicationAgent agent = new ReplicationAgent())
     {
        // call methods on agent here...
     }
  }

SetFreetextSearchEnabledOnArea(Int32, Boolean)

Enable freetext search on this area

Declaration

public void SetFreetextSearchEnabledOnArea(int areaId, bool freetextEnabled)

Parameters

Type	Name	Description
Int32	areaId	The id of the area
Boolean	freetextEnabled	True if freetextSearch on this area shall be enabled

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ReplicationAgent agent = new ReplicationAgent())
     {
        // call methods on agent here...
     }
  }

Implements

System.IDisposable

IReplicationAgent

IAgent