NSForeignSystemAgent - SuperOffice

Collection of all services that works with Foreign key data (Key/Value pairs)

Constructors

NSForeignSystemAgent()

NSForeignSystemAgent

Methods

AddDeviceByIdentifier(String,String,String)

Adds a new NSForeignDevice with deviceName that belongs to the application with applicationName, with an optional device-specific identifier.

NSForeignDevice AddDeviceByIdentifier(String applicationName, String deviceName, String deviceIdentifier)

Returns: CRMScript.NetServer.NSForeignDevice Example:

NSForeignSystemAgent agent;
String applicationName;
String deviceName;
String deviceIdentifier;
NSForeignDevice res = agent.AddDeviceByIdentifier(applicationName, deviceName, deviceIdentifier);

AddForeignKey(NSForeignKey,String,String,String)

Adds a new key belonging to the ForeignApp and NSForeignDevice specified.

NSForeignKey AddForeignKey(NSForeignKey foreignKey, String applicationName, String deviceName, String deviceIdentifier)

Returns: CRMScript.NetServer.NSForeignKey Example:

NSForeignSystemAgent agent;
NSForeignKey foreignKey;
String applicationName;
String deviceName;
String deviceIdentifier;
NSForeignKey res = agent.AddForeignKey(foreignKey, applicationName, deviceName, deviceIdentifier);

CreateDefaultForeignAppEntity()

Sets default values into a new NSForeignAppEntity.

NSForeignAppEntity CreateDefaultForeignAppEntity()

Returns: CRMScript.NetServer.NSForeignAppEntity

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

Example:

NSForeignSystemAgent agent;
NSForeignAppEntity thing = agent.CreateDefaultForeignAppEntity();
thing = agent.SaveForeignAppEntity(thing);

DeleteDeviceByIdentifier(String,String,String)

Deletes an NSForeignDevice with deviceName and deviceIdentifier that belongs to the application with applicationName.

Void DeleteDeviceByIdentifier(String applicationName, String deviceName, String deviceIdentifier)

Returns: CRMScript.Global.Void Example:

NSForeignSystemAgent agent;
String applicationName;
String deviceName;
String deviceIdentifier;
agent.DeleteDeviceByIdentifier(applicationName, deviceName, deviceIdentifier);

DeleteForeignAppEntity(Integer)

Deletes the NSForeignAppEntity

Void DeleteForeignAppEntity(Integer foreignAppEntity)

Returns: CRMScript.Global.Void Example:

NSForeignSystemAgent agent;
agent.DeleteForeignAppEntity(123);

DeleteForeignDevice(NSForeignDevice,String)

Deletes a foreign device from an application

Void DeleteForeignDevice(NSForeignDevice foreignDevice, String applicationName)

Returns: CRMScript.Global.Void

DeleteForeignKey(NSForeignKey,String,String,String,String,Integer)

Deletes all specified occurrences of a key, belonging to the ForeignApp and NSForeignDevice, table and record specified. Specifying a blank table name will delete ALL keys of the given name; specifying a recordID of 0 will delete ALL keys of the given name for the given table.

Void DeleteForeignKey(NSForeignKey foreignKey, String applicationName, String deviceName, String deviceIdentifier, String tableName, Integer recordId)

Returns: CRMScript.Global.Void Example:

NSForeignSystemAgent agent;
NSForeignKey foreignKey;
String applicationName;
String deviceName;
String deviceIdentifier;
String tableName;
Integer recordId;
agent.DeleteForeignKey(foreignKey, applicationName, deviceName, deviceIdentifier, tableName, recordId);

DeleteForeignKeyOnName(String,String,String,String,String,Integer)

Void DeleteForeignKeyOnName(String applicationName, String deviceName, String deviceIdentifier, String keyName, String tableName, Integer recordId)

Returns: CRMScript.Global.Void Example:

NSForeignSystemAgent agent;
String applicationName;
String deviceName;
String deviceIdentifier;
String keyName;
String tableName;
Integer recordId;
agent.DeleteForeignKeyOnName(applicationName, deviceName, deviceIdentifier, keyName, tableName, recordId);

GetAllForeignKeysOnEntity(String,Integer)

Gets a list of foreignkeys (‘app.device.key’) and their values (‘123’) that belong to the specified entity.

Map GetAllForeignKeysOnEntity(String entityType, Integer entityId)

Returns: CRMScript.Native.Map Example:

NSForeignSystemAgent agent;
String entityType;
Integer entityId;
Map res = agent.GetAllForeignKeysOnEntity(entityType, entityId);

GetAppByName(String)

Gets the ForeignApp with the given name.

NSForeignAppEntity GetAppByName(String applicationName)

Returns: CRMScript.NetServer.NSForeignAppEntity Example:

NSForeignSystemAgent agent;
String applicationName;
NSForeignAppEntity res = agent.GetAppByName(applicationName);

GetApplicationDevices(String)

Gets all devices that belong to a foreign application.

NSForeignDevice[] GetApplicationDevices(String applicationName)

Returns: CRMScript.NetServer.NSForeignDevice[] Example:

NSForeignSystemAgent agent;
String applicationName;
NSForeignDevice[] res = agent.GetApplicationDevices(applicationName);

GetApplicationKeys(String)

Returns all ForeignKeys that belong to an application.

NSForeignKey[] GetApplicationKeys(String applicationName)

Returns: CRMScript.NetServer.NSForeignKey[] - All ForeignKeys that belong to this application. Example:

NSForeignSystemAgent agent;
String applicationName;
NSForeignKey[] res = agent.GetApplicationKeys(applicationName);

GetDeviceByIdentifier(String,String,String)

Gets an NSForeignDevice with deviceName and deviceIdentifier that belongs to the application with applicationName.

NSForeignDevice GetDeviceByIdentifier(String applicationName, String deviceName, String deviceIdentifier)

Returns: CRMScript.NetServer.NSForeignDevice Example:

NSForeignSystemAgent agent;
String applicationName;
String deviceName;
String deviceIdentifier;
NSForeignDevice res = agent.GetDeviceByIdentifier(applicationName, deviceName, deviceIdentifier);

GetDeviceByName(String,String)

Gets an NSForeignDevice with deviceName that belongs to the application with applicationName.

NSForeignDevice GetDeviceByName(String applicationName, String deviceName)

Returns: CRMScript.NetServer.NSForeignDevice Example:

NSForeignSystemAgent agent;
String applicationName;
String deviceName;
NSForeignDevice res = agent.GetDeviceByName(applicationName, deviceName);

GetDeviceKeys(String,String)

Returns all ForeignKeys that belong to a device.

NSForeignKey[] GetDeviceKeys(String applicationName, String deviceName)

Returns: CRMScript.NetServer.NSForeignKey[] Example:

NSForeignSystemAgent agent;
String applicationName;
String deviceName;
NSForeignKey[] res = agent.GetDeviceKeys(applicationName, deviceName);

GetDeviceKeysOnDeviceIdentifier(String,String,String)

Returns all ForeignKeys that belong to a device with a given deviceIdentifier.

NSForeignKey[] GetDeviceKeysOnDeviceIdentifier(String applicationName, String deviceName, String deviceIdentifier)

Returns: CRMScript.NetServer.NSForeignKey[] Example:

NSForeignSystemAgent agent;
String applicationName;
String deviceName;
String deviceIdentifier;
NSForeignKey[] res = agent.GetDeviceKeysOnDeviceIdentifier(applicationName, deviceName, deviceIdentifier);

GetDeviceKeysOnDeviceIdentifierTable(String,String,String,String)

Returns all ForeignKeys that belong to a device with a given deviceIdentifier and table name.

NSForeignKey[] GetDeviceKeysOnDeviceIdentifierTable(String applicationName, String deviceName, String deviceIdentifier, String tableName)

Returns: CRMScript.NetServer.NSForeignKey[] Example:

NSForeignSystemAgent agent;
String applicationName;
String deviceName;
String deviceIdentifier;
String tableName;
NSForeignKey[] res = agent.GetDeviceKeysOnDeviceIdentifierTable(applicationName, deviceName, deviceIdentifier, tableName);

GetDeviceKeysOnDeviceIdentifierTableRecordId(String,String,String,String,Integer)

Returns all ForeignKeys that belong to a device with a given deviceIdentifier and table name, as well as record id.

NSForeignKey[] GetDeviceKeysOnDeviceIdentifierTableRecordId(String applicationName, String deviceName, String deviceIdentifier, String tableName, Integer recordId)

Returns: CRMScript.NetServer.NSForeignKey[] Example:

NSForeignSystemAgent agent;
String applicationName;
String deviceName;
String deviceIdentifier;
String tableName;
Integer recordId;
NSForeignKey[] res = agent.GetDeviceKeysOnDeviceIdentifierTableRecordId(applicationName, deviceName, deviceIdentifier, tableName, recordId);

GetForeignAppEntity(Integer)

Gets an NSForeignAppEntity object.

NSForeignAppEntity GetForeignAppEntity(Integer foreignAppEntityId)

Returns: CRMScript.NetServer.NSForeignAppEntity Example:

NSForeignSystemAgent agent;
NSForeignAppEntity thing = agent.GetForeignAppEntity(123);

GetForeignDevice(Integer)

Gets an NSForeignDevice object.

NSForeignDevice GetForeignDevice(Integer foreignDeviceId)

Returns: CRMScript.NetServer.NSForeignDevice Example:

NSForeignSystemAgent agent;
NSForeignDevice thing = agent.GetForeignDevice(123);

GetKey(String,String,String,String,Integer)

Returns a foreign key by its key name that belongs to the specified device and application. A table name and record ID can also be specified.

NSForeignKey GetKey(String applicationName, String deviceName, String keyName, String tableName, Integer recordId)

Returns: CRMScript.NetServer.NSForeignKey Example:

NSForeignSystemAgent agent;
String applicationName;
String deviceName;
String keyName;
String tableName;
Integer recordId;
NSForeignKey res = agent.GetKey(applicationName, deviceName, keyName, tableName, recordId);

GetKeyByValue(String,String,String,String,String)

Gets a foreignkey based on its name and value, that belongs to the specified device and application.

NSForeignKey GetKeyByValue(String applicationName, String deviceName, String keyName, String keyValue, String tableName)

Returns: CRMScript.NetServer.NSForeignKey Example:

NSForeignSystemAgent agent;
String applicationName;
String deviceName;
String keyName;
String keyValue;
String tableName;
NSForeignKey res = agent.GetKeyByValue(applicationName, deviceName, keyName, keyValue, tableName);

GetKeyByValueAndIdentifier(String,String,String,String,String,String)

Gets a foreignkey based on its name and value, that belongs to the specified deviceId, device, and application.

NSForeignKey GetKeyByValueAndIdentifier(String applicationName, String deviceName, String deviceIdentifier, String keyName, String keyValue, String tableName)

Returns: CRMScript.NetServer.NSForeignKey Example:

NSForeignSystemAgent agent;
String applicationName;
String deviceName;
String deviceIdentifier;
String keyName;
String keyValue;
String tableName;
NSForeignKey res = agent.GetKeyByValueAndIdentifier(applicationName, deviceName, deviceIdentifier, keyName, keyValue, tableName);

GetKeyOnDeviceIdentifier(String,String,String,String,String,Integer)

Returns a foreign key by its key name and device identifier, that belongs to the specified device and application. A table name and record ID can also be specified.

NSForeignKey GetKeyOnDeviceIdentifier(String applicationName, String deviceName, String deviceIdentifier, String keyName, String tableName, Integer recordId)

Returns: CRMScript.NetServer.NSForeignKey Example:

NSForeignSystemAgent agent;
String applicationName;
String deviceName;
String deviceIdentifier;
String keyName;
String tableName;
Integer recordId;
NSForeignKey res = agent.GetKeyOnDeviceIdentifier(applicationName, deviceName, deviceIdentifier, keyName, tableName, recordId);

GetKeyValue(String,String,String,String,Integer)

Gets the string value of an NSForeignKey, that belongs to the specified device and application. The table name and record ID must also be specified.

String GetKeyValue(String applicationName, String deviceName, String keyName, String tableName, Integer recordId)

Returns: CRMScript.Global.String Example:

NSForeignSystemAgent agent;
String applicationName;
String deviceName;
String keyName;
String tableName;
Integer recordId;
String res = agent.GetKeyValue(applicationName, deviceName, keyName, tableName, recordId);

GetKeyValueOnDeviceIdentifier(String,String,String,String,String,Integer)

Returns a foreign key string value by its key name and device identifier, that belongs to the specified device and application. A table name and record ID can also be specified.

String GetKeyValueOnDeviceIdentifier(String applicationName, String deviceName, String deviceIdentifier, String keyName, String tableName, Integer recordId)

Returns: CRMScript.Global.String Example:

NSForeignSystemAgent agent;
String applicationName;
String deviceName;
String deviceIdentifier;
String keyName;
String tableName;
Integer recordId;
String res = agent.GetKeyValueOnDeviceIdentifier(applicationName, deviceName, deviceIdentifier, keyName, tableName, recordId);

SaveDeviceByIdentifier(String,String,String,NSForeignDevice)

Updates an NSForeignDevice with deviceName that belongs to the application with applicationName.

NSForeignDevice SaveDeviceByIdentifier(String applicationName, String deviceName, String deviceIdentifier, NSForeignDevice foreignDevice)

Returns: CRMScript.NetServer.NSForeignDevice Example:

NSForeignSystemAgent agent;
String applicationName;
String deviceName;
String deviceIdentifier;
NSForeignDevice foreignDevice;
NSForeignDevice res = agent.SaveDeviceByIdentifier(applicationName, deviceName, deviceIdentifier, foreignDevice);

SaveForeignAppEntity(NSForeignAppEntity)

yUpdates the existing NSForeignAppEntity or creates a new NSForeignAppEntity if the ID parameter is 0.

NSForeignAppEntity SaveForeignAppEntity(NSForeignAppEntity foreignAppEntity)

Returns: CRMScript.NetServer.NSForeignAppEntity - The new or updated NSForeignAppEntity. Example:

NSForeignSystem  agent;
NSForeignAppEntity thing = agent.CreateDefaultForeignAppEntity();
thing = agent.SaveForeignAppEntity(thing);

SaveForeignDevice(NSForeignDevice,String)

Saves a foreign device for an foreign application

NSForeignDevice SaveForeignDevice(NSForeignDevice foreignDevice, String applicationName)

Returns: CRMScript.NetServer.NSForeignDevice Example:

NSForeignSystemAgent agent;
NSForeignDevice foreignDevice;
String applicationName;
NSForeignDevice res = agent.SaveForeignDevice(foreignDevice, applicationName);

SaveForeignKey(NSForeignKey,String,String,String)

Saves a key belonging to the ForeignApp and NSForeignDevice specified.

NSForeignKey SaveForeignKey(NSForeignKey foreignKey, String applicationName, String deviceName, String deviceIdentifier)

Returns: CRMScript.NetServer.NSForeignKey Example:

NSForeignSystemAgent agent;
NSForeignKey foreignKey;
String applicationName;
String deviceName;
String deviceIdentifier;
NSForeignKey res = agent.SaveForeignKey(foreignKey, applicationName, deviceName, deviceIdentifier);

​Constructors

​NSForeignSystemAgent()

​Methods

​AddDeviceByIdentifier(String,String,String)

​AddForeignKey(NSForeignKey,String,String,String)

​CreateDefaultForeignAppEntity()

​DeleteDeviceByIdentifier(String,String,String)

​DeleteForeignAppEntity(Integer)

​DeleteForeignDevice(NSForeignDevice,String)

​DeleteForeignKey(NSForeignKey,String,String,String,String,Integer)

​DeleteForeignKeyOnName(String,String,String,String,String,Integer)

​GetAllForeignKeysOnEntity(String,Integer)

​GetAppByName(String)

​GetApplicationDevices(String)

​GetApplicationKeys(String)

​GetDeviceByIdentifier(String,String,String)

​GetDeviceByName(String,String)

​GetDeviceKeys(String,String)

​GetDeviceKeysOnDeviceIdentifier(String,String,String)

​GetDeviceKeysOnDeviceIdentifierTable(String,String,String,String)

​GetDeviceKeysOnDeviceIdentifierTableRecordId(String,String,String,String,Integer)

​GetForeignAppEntity(Integer)

​GetForeignDevice(Integer)

​GetKey(String,String,String,String,Integer)

​GetKeyByValue(String,String,String,String,String)

​GetKeyByValueAndIdentifier(String,String,String,String,String,String)

​GetKeyOnDeviceIdentifier(String,String,String,String,String,Integer)

​GetKeyValue(String,String,String,String,Integer)

​GetKeyValueOnDeviceIdentifier(String,String,String,String,String,Integer)

​SaveDeviceByIdentifier(String,String,String,NSForeignDevice)

​SaveForeignAppEntity(NSForeignAppEntity)

​SaveForeignDevice(NSForeignDevice,String)

​SaveForeignKey(NSForeignKey,String,String,String)

Constructors

NSForeignSystemAgent()

Methods

AddDeviceByIdentifier(String,String,String)

AddForeignKey(NSForeignKey,String,String,String)

CreateDefaultForeignAppEntity()

DeleteDeviceByIdentifier(String,String,String)

DeleteForeignAppEntity(Integer)

DeleteForeignDevice(NSForeignDevice,String)

DeleteForeignKey(NSForeignKey,String,String,String,String,Integer)

DeleteForeignKeyOnName(String,String,String,String,String,Integer)

GetAllForeignKeysOnEntity(String,Integer)

GetAppByName(String)

GetApplicationDevices(String)

GetApplicationKeys(String)

GetDeviceByIdentifier(String,String,String)

GetDeviceByName(String,String)

GetDeviceKeys(String,String)

GetDeviceKeysOnDeviceIdentifier(String,String,String)

GetDeviceKeysOnDeviceIdentifierTable(String,String,String,String)

GetDeviceKeysOnDeviceIdentifierTableRecordId(String,String,String,String,Integer)

GetForeignAppEntity(Integer)

GetForeignDevice(Integer)

GetKey(String,String,String,String,Integer)

GetKeyByValue(String,String,String,String,String)

GetKeyByValueAndIdentifier(String,String,String,String,String,String)

GetKeyOnDeviceIdentifier(String,String,String,String,String,Integer)

GetKeyValue(String,String,String,String,Integer)

GetKeyValueOnDeviceIdentifier(String,String,String,String,String,Integer)

SaveDeviceByIdentifier(String,String,String,NSForeignDevice)

SaveForeignAppEntity(NSForeignAppEntity)

SaveForeignDevice(NSForeignDevice,String)

SaveForeignKey(NSForeignKey,String,String,String)