Interface IForeignSystemAgent

Interface for the ForeignSystem Agent Collection of all services that works with Foreign key data (Key/Value pairs)

Namespace: SuperOffice.CRM.Services

Assembly: SuperOffice.Services.dll

Syntax

[Agent("ForeignSystem Agent", "Interface for the ForeignSystem Agent. Collection of all services that works with Foreign key data (Key/Value pairs)")]
public interface IForeignSystemAgent : IAgent

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

Methods

AddDeviceByIdentifier(String, String, String)

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

Declaration

ForeignDevice AddDeviceByIdentifier(string applicationName, string deviceName, string deviceIdentifier)

Parameters

Type	Name	Description
String	applicationName	The name of the foreign application.
String	deviceName	The name of the foreign device.
String	deviceIdentifier	Unique id of device (Palm pilot device ID, version number, etc)

Returns

Type	Description
ForeignDevice	The ForeignDevice.

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

AddForeignKey(ForeignKey, String, String, String)

Add a new key belonging to the ForeignApp and ForeignDevice specified.

Declaration

ForeignKey AddForeignKey(ForeignKey foreignKey, string applicationName, string deviceName, string deviceIdentifier)

Parameters

Type	Name	Description
ForeignKey	foreignKey	Foreign key to save
String	applicationName	The name of the foreign application.
String	deviceName	The name of the foreign device.
String	deviceIdentifier	The device identifier. Optional if device identifier is not used.

Returns

Type	Description
ForeignKey	The new or updated ForeignKey

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

CreateDefaultForeignAppEntity()

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

Declaration

ForeignAppEntity CreateDefaultForeignAppEntity()

Returns

Type	Description
ForeignAppEntity	New ForeignAppEntity with default values

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

DeleteDeviceByIdentifier(String, String, String)

Delete a ForeignDevice with deviceName and deviceIdentifier that belongs to the application with applicationName.

Declaration

void DeleteDeviceByIdentifier(string applicationName, string deviceName, string deviceIdentifier)

Parameters

Type	Name	Description
String	applicationName	The name of the foreign application.
String	deviceName	The name of the foreign device.
String	deviceIdentifier	Unique id of device (Palm pilot device ID, version number, etc)

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

DeleteForeignAppEntity(Int32)

Deletes the ForeignAppEntity

Declaration

void DeleteForeignAppEntity(int foreignAppEntityId)

Parameters

Type	Name	Description
Int32	foreignAppEntityId	The identity of the ForeignAppEntity

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

DeleteForeignDevice(ForeignDevice, String)

Deletes a foreign device from an application

Declaration

void DeleteForeignDevice(ForeignDevice foreignDevice, string applicationName)

Parameters

Type	Name	Description
ForeignDevice	foreignDevice	foreign device to delete
String	applicationName	Name of application to delete from

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

DeleteForeignKey(ForeignKey, String, String, String, String, Int32)

Deletes all specified occurrences of a key, belonging to the ForeignApp and ForeignDevice, 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.

Declaration

void DeleteForeignKey(ForeignKey foreignKey, string applicationName, string deviceName, string deviceIdentifier, string tableName, int recordId)

Parameters

Type	Name	Description
ForeignKey	foreignKey	Key name to delete.
String	applicationName	The name of the foreign application.
String	deviceName	The name of the foreign device.
String	deviceIdentifier	The device identifier. Optional if device identifier is not used.
String	tableName	Table name, transformed to and from numeric table id by the service layer.<p/>Use an empty string to delete ALL keys that otherwise match; this may be dangerous and can take a long time if there are many items to delete.
Int32	recordId	Id of record that this key refers to. If the table name was blank, then this parameter must be 0. It can also be 0 to mean that the foreign key record was not bound to any particular record of the target table.<p/>Specifying a zero recordId will remove the recordId restriction and delete all keys that otherwise match.

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

DeleteForeignKeyOnName(String, String, String, String, String, Int32)

Deletes all specified occurrences of a key, belonging to the ForeignApp and ForeignDevice, 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.

Declaration

void DeleteForeignKeyOnName(string applicationName, string deviceName, string deviceIdentifier, string keyName, string tableName, int recordId)

Parameters

Type	Name	Description
String	applicationName	The name of the foreign application.
String	deviceName	The name of the foreign device.
String	deviceIdentifier	The device identifier. Optional if device identifier is not used.
String	keyName	The name of the foreign key to delete.
String	tableName	Table name, transformed to and from numeric table id by the service layer.<p/>Use an empty string to delete ALL keys that otherwise match; this may be dangerous and can take a long time if there are many items to delete.
Int32	recordId	Id of record that this key refers to. If the table name was blank, then this parameter must be 0. It can also be 0 to mean that the foreign key record was not bound to any particular record of the target table.<p/>Specifying a zero recordId will remove the recordId restriction and delete all keys that otherwise match.

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

GetAllForeignKeysOnEntity(String, Int32)

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

Declaration

StringDictionary GetAllForeignKeysOnEntity(string entityType, int entityId)

Parameters

Type	Name	Description
String	entityType	Entity type (table name): 'contact', 'project' etc.
Int32	entityId	Primary key of Entity

Returns

Type	Description
StringDictionary	Dictionary of 'appname.deviceid.keyname' = '123' key values

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

GetAppByName(String)

Gets the ForeignApp with the given name.

Declaration

ForeignAppEntity GetAppByName(string applicationName)

Parameters

Type	Name	Description
String	applicationName	The name of the foreign application.

Returns

Type	Description
ForeignAppEntity	The ForeignApp that matches the name.

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

GetApplicationDevices(String)

Gets all devices that belong to a foreign application.

Declaration

ForeignDevice[] GetApplicationDevices(string applicationName)

Parameters

Type	Name	Description
String	applicationName	The foreign application name

Returns

Type	Description
ForeignDevice[]	Array of ForeignDevices

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

GetApplicationKeys(String)

Returns all ForeignKeys that belong to an application.

Declaration

ForeignKey[] GetApplicationKeys(string applicationName)

Parameters

Type	Name	Description
String	applicationName	The name of the foreign application.

Returns

Type	Description
ForeignKey[]	Array of all ForeignKeys in the ForeignApp.

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

GetDeviceByIdentifier(String, String, String)

Gets a ForeignDevice with deviceName and deviceIdentifier that belongs to the application with applicationName.

Declaration

ForeignDevice GetDeviceByIdentifier(string applicationName, string deviceName, string deviceIdentifier)

Parameters

Type	Name	Description
String	applicationName	The name of the foreign application.
String	deviceName	The name of the foreign device.
String	deviceIdentifier	Optional unique id of device (Palm pilot device ID, version number, etc)

Returns

Type	Description
ForeignDevice	The ForeignDevice.

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

GetDeviceByName(String, String)

Gets a ForeignDevice with deviceName that belongs to the application with applicationName.

Declaration

ForeignDevice GetDeviceByName(string applicationName, string deviceName)

Parameters

Type	Name	Description
String	applicationName	The name of the foreign application.
String	deviceName	The name of the foreign device.

Returns

Type	Description
ForeignDevice	The ForeignDevice.

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

GetDeviceKeys(String, String)

Returns all ForeignKeys that belong to a device.

Declaration

ForeignKey[] GetDeviceKeys(string applicationName, string deviceName)

Parameters

Type	Name	Description
String	applicationName	The name of the foreign application.
String	deviceName	The name of the foreign device.

Returns

Type	Description
ForeignKey[]	Array of all ForeignKeys in the ForeignDevice.

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

GetDeviceKeysOnDeviceIdentifier(String, String, String)

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

Declaration

ForeignKey[] GetDeviceKeysOnDeviceIdentifier(string applicationName, string deviceName, string deviceIdentifier)

Parameters

Type	Name	Description
String	applicationName	The name of the foreign application.
String	deviceName	The name of the foreign device.
String	deviceIdentifier	Identifier for a unique grouping of keys within a device.

Returns

Type	Description
ForeignKey[]	Array of all ForeignKeys in the ForeignDevice that belong to the DeviceIdentifier.

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

GetDeviceKeysOnDeviceIdentifierTable(String, String, String, String)

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

Declaration

ForeignKey[] GetDeviceKeysOnDeviceIdentifierTable(string applicationName, string deviceName, string deviceIdentifier, string tableName)

Parameters

Type	Name	Description
String	applicationName	The name of the foreign application.
String	deviceName	The name of the foreign device.
String	deviceIdentifier	Identifier for a unique grouping of keys within a device.
String	tableName	Table name, transformed to and from numeric table id by the service layer.<p/>Use an empty string to indicate that your key is not bound to any specific table.

Returns

Type	Description
ForeignKey[]	Array of all ForeignKeys in the ForeignDevice that belong to the DeviceIdentifier.

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

GetDeviceKeysOnDeviceIdentifierTableRecordId(String, String, String, String, Int32)

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

Declaration

ForeignKey[] GetDeviceKeysOnDeviceIdentifierTableRecordId(string applicationName, string deviceName, string deviceIdentifier, string tableName, int recordId)

Parameters

Type	Name	Description
String	applicationName	The name of the foreign application.
String	deviceName	The name of the foreign device.
String	deviceIdentifier	Identifier for a unique grouping of keys within a device.
String	tableName	Table name, transformed to and from numeric table id by the service layer.<p/>Use an empty string to indicate that your key is not bound to any specific table.
Int32	recordId	Id of record that this key refers to. If the table name was blank, then this parameter must be 0. It can also be 0 to mean that the foreign key record was not bound to any particular record of the target table.

Returns

Type	Description
ForeignKey[]	Array of all ForeignKeys in the ForeignDevice that match the criteria

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

GetForeignAppEntity(Int32)

Gets a ForeignAppEntity object.

Declaration

ForeignAppEntity GetForeignAppEntity(int foreignAppEntityId)

Parameters

Type	Name	Description
Int32	foreignAppEntityId	The identifier of the ForeignAppEntity object

Returns

Type	Description
ForeignAppEntity	ForeignAppEntity

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

GetForeignDevice(Int32)

Gets a ForeignDevice object.

Declaration

ForeignDevice GetForeignDevice(int foreignDeviceId)

Parameters

Type	Name	Description
Int32	foreignDeviceId	The identifier of the ForeignDevice object

Returns

Type	Description
ForeignDevice	ForeignDevice

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

GetKey(String, String, String, String, Int32)

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

Declaration

ForeignKey GetKey(string applicationName, string deviceName, string keyName, string tableName, int recordId)

Parameters

Type	Name	Description
String	applicationName	The name of the foreign application.
String	deviceName	The name of the foreign device.
String	keyName	The name of the foreign key.
String	tableName	Table name, transformed to and from numeric table id by the service layer.<p/>Use an empty string to indicate that your key is not bound to any specific table.
Int32	recordId	Id of record that this key refers to. If the table name was blank, then this parameter must be 0. It can also be 0 to mean that the foreign key record was not bound to any particular record of the target table.

Returns

Type	Description
ForeignKey	The ForeignKey.

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

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

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

Declaration

ForeignKey GetKeyByValue(string applicationName, string deviceName, string keyName, string keyValue, string tableName)

Parameters

Type	Name	Description
String	applicationName	The name of the foreign application.
String	deviceName	The name of the foreign device.
String	keyName	The name of the foreign key.
String	keyValue	Foreignkey value
String	tableName	Table name, transformed to and from numeric table id by the service layer.<p/>Use an empty string to indicate that your key is not bound to any specific table.

Returns

Type	Description
ForeignKey	The ForeignKey.

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

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

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

Declaration

ForeignKey GetKeyByValueAndIdentifier(string applicationName, string deviceName, string deviceIdentifier, string keyName, string keyValue, string tableName)

Parameters

Type	Name	Description
String	applicationName	The name of the foreign application.
String	deviceName	The name of the foreign device.
String	deviceIdentifier	The device identifier. Optional if device identifier is not used.
String	keyName	The name of the foreign key.
String	keyValue	Foreignkey value
String	tableName	Table name, transformed to and from numeric table id by the service layer.<p/>Use an empty string to indicate that your key is not bound to any specific table.

Returns

Type	Description
ForeignKey	The ForeignKey.

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

GetKeyOnDeviceIdentifier(String, String, String, String, String, Int32)

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

Declaration

ForeignKey GetKeyOnDeviceIdentifier(string applicationName, string deviceName, string deviceIdentifier, string keyName, string tableName, int recordId)

Parameters

Type	Name	Description
String	applicationName	The name of the foreign application.
String	deviceName	The name of the foreign device.
String	deviceIdentifier	The device identifier.
String	keyName	The name of the foreign key.
String	tableName	Table name, transformed to and from numeric table id by the service layer.<p/>Use an empty string to indicate that your key is not bound to any specific table.
Int32	recordId	Id of record that this key refers to. If the table name was blank, then this parameter must be 0. It can also be 0 to mean that the foreign key record was not bound to any particular record of the target table.

Returns

Type	Description
ForeignKey	The ForeignKey.

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

GetKeyValue(String, String, String, String, Int32)

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

Declaration

string GetKeyValue(string applicationName, string deviceName, string keyName, string tableName, int recordId)

Parameters

Type	Name	Description
String	applicationName	The name of the foreign application.
String	deviceName	The name of the foreign device.
String	keyName	The name of the foreign key.
String	tableName	Table name, transformed to and from numeric table id by the service layer.<p/>Use an empty string to indicate that your key is not bound to any specific table.
Int32	recordId	Id of record that this key refers to. If the table name was blank, then this parameter must be 0. It can also be 0 to mean that the foreign key record was not bound to any particular record of the target table.

Returns

Type	Description
String	The ForeignKey value as string.

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

GetKeyValueOnDeviceIdentifier(String, String, String, String, String, Int32)

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

Declaration

string GetKeyValueOnDeviceIdentifier(string applicationName, string deviceName, string deviceIdentifier, string keyName, string tableName, int recordId)

Parameters

Type	Name	Description
String	applicationName	The name of the foreign application.
String	deviceName	The name of the foreign device.
String	deviceIdentifier	The device identifier.
String	keyName	The name of the foreign key.
String	tableName	Table name, transformed to and from numeric table id by the service layer.<p/>Use an empty string to indicate that your key is not bound to any specific table.
Int32	recordId	Id of record that this key refers to. If the table name was blank, then this parameter must be 0. It can also be 0 to mean that the foreign key record was not bound to any particular record of the target table.

Returns

Type	Description
String	The ForeignKey's string value.

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

SaveDeviceByIdentifier(String, String, String, ForeignDevice)

Updates a ForeignDevice with deviceName that belongs to the application with applicationName.

Declaration

ForeignDevice SaveDeviceByIdentifier(string applicationName, string deviceName, string deviceIdentifier, ForeignDevice foreignDevice)

Parameters

Type	Name	Description
String	applicationName	The name of the foreign application.
String	deviceName	The name of the foreign device.
String	deviceIdentifier	Unique id of device (Palm pilot device ID, version number, etc)
ForeignDevice	foreignDevice	Foreign device to save. Can be null if adding new device.

Returns

Type	Description
ForeignDevice	The ForeignDevice.

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

SaveForeignAppEntity(ForeignAppEntity)

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

Declaration

ForeignAppEntity SaveForeignAppEntity(ForeignAppEntity foreignAppEntity)

Parameters

Type	Name	Description
ForeignAppEntity	foreignAppEntity	The ForeignAppEntity that is saved.

Returns

Type	Description
ForeignAppEntity	New or updated ForeignAppEntity

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

SaveForeignDevice(ForeignDevice, String)

Saves a foreign device for an foreign application

Declaration

ForeignDevice SaveForeignDevice(ForeignDevice foreignDevice, string applicationName)

Parameters

Type	Name	Description
ForeignDevice	foreignDevice	Foreign device to save
String	applicationName	The name of the foreign application.

Returns

Type	Description
ForeignDevice	Returns the saved foreign device

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

SaveForeignKey(ForeignKey, String, String, String)

Saves a key belonging to the ForeignApp and ForeignDevice specified.

Declaration

ForeignKey SaveForeignKey(ForeignKey foreignKey, string applicationName, string deviceName, string deviceIdentifier)

Parameters

Type	Name	Description
ForeignKey	foreignKey	Foreign key to save
String	applicationName	The name of the foreign application.
String	deviceName	The name of the foreign device.
String	deviceIdentifier	The device identifier. Optional if device identifier is not used.

Returns

Type	Description
ForeignKey	The new or updated ForeignKey

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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