Show / Hide Table of Contents

Class NSReplicationAgent

Replication/Travel administration.

Syntax
Examples
NSReplicationAgent agent;
agent.callMethod(arg1, arg2);

Constructors

NSReplicationAgent()

Replication/Travel administration.

Declaration
NSReplicationAgent
Examples
NSReplicationAgent agent;
agent.callMethod(arg1, arg2);

Methods

CreateDefaultSatellite()

Sets default values into a new NSSatellite.

Declaration
NSSatellite CreateDefaultSatellite()
Returns
Type Description
NSSatellite
Remarks

NetServer calculates default values (for example, Country) on the entity, which is required when creating/storing a new instance

Examples
NSReplicationAgent agent;
NSSatellite thing = agent.CreateDefaultSatellite();
thing = agent.SaveSatellite(thing);

GetArea(Integer)

Gets an NSArea object.

Declaration
NSArea GetArea(Integer areaId)
Parameters
Type Name Description
Integer areaId
Returns
Type Description
NSArea
Examples
NSReplicationAgent agent;
NSArea thing = agent.GetArea(123);

GetAreaList(Integer[])

Gets an array of NSArea objectsGets an array of NSArea objects.

Declaration
NSArea[] GetAreaList(Integer[] areaIds)
Parameters
Type Name Description
Integer[] areaIds

The identifiers of the NSArea objects.

Returns
Type Description
Examples
Integer[] ids;
NSReplicationAgent agent;
agent.GetAreaList(ids);

GetCentralLicense()

Replication/Travel administration.

Declaration
NSLicenseOwner[] GetCentralLicense()
Returns
Type Description
NSLicenseOwner[]
Examples
NSReplicationAgent agent;
agent.callMethod(arg1, arg2);

GetSatellite(Integer)

Gets an NSSatellite object.

Declaration
NSSatellite GetSatellite(Integer satelliteId)
Parameters
Type Name Description
Integer satelliteId
Returns
Type Description
NSSatellite
Examples
NSReplicationAgent agent;
NSSatellite thing = agent.GetSatellite(123);

SaveCentralLicense(NSLicenseOwner[])

Replication/Travel administration.

Declaration
NSLicenseOwner[] SaveCentralLicense(NSLicenseOwner[] license)
Parameters
Type Name Description
NSLicenseOwner[] license
Returns
Type Description
NSLicenseOwner[]
Examples
NSReplicationAgent agent;
agent.callMethod(arg1, arg2);

SaveSatellite(NSSatellite)

Updates the existing NSSatellite or creates a new NSSatellite if the ID parameter is 0.

Declaration
NSSatellite SaveSatellite(NSSatellite satellite)
Parameters
Type Name Description
NSSatellite satellite
Returns
Type Description
NSSatellite

The new or updated NSSatellite.

Examples
NSReplication  agent;
NSSatellite thing = agent.CreateDefaultSatellite();
thing = agent.SaveSatellite(thing);

SetFreetextSearchEnabledOnArea(Integer,Bool)

Enables free-text search on this area

Declaration
Void SetFreetextSearchEnabledOnArea(Integer areaId, Bool freetextEnabled)
Parameters
Type Name Description
Integer areaId
Bool freetextEnabled
Returns
Type Description
Void
Examples
NSReplicationAgent agent;
Integer areaId;
Bool freetextEnabled;
agent.SetFreetextSearchEnabledOnArea(areaId, freetextEnabled);
In This Article
© SuperOffice. All rights reserved.
SuperOffice |  Community |  Release Notes |  Privacy |  Site feedback |  Search Docs |  About Docs |  Contribute |  Back to top