Class PreferenceAgent

Facade for the Preference Agent Preferences, user interface tab configuration

Inheritance

Object

AgentBase<IPreferenceAgent>

PreferenceAgent

Implements

IDisposable

IPreferenceAgent

IAgent

Inherited Members

AgentBase<IPreferenceAgent>.Dispose()

AgentBase<IPreferenceAgent>.InnerAgent

Namespace: SuperOffice.CRM.Services

Assembly: SuperOffice.Services.dll

Syntax

public class PreferenceAgent : AgentBase<IPreferenceAgent>, IDisposable, IPreferenceAgent, IAgent

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

Constructors

PreferenceAgent()

Facade for the Preference Agent Preferences, user interface tab configuration

Declaration

public PreferenceAgent()

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

Methods

CreateDefaultPreference()

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

Declaration

public Preference CreateDefaultPreference()

Returns

Type	Description
Preference	New Preference with default values

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

CreateDefaultPreferenceDescription()

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

Declaration

public PreferenceDescription CreateDefaultPreferenceDescription()

Returns

Type	Description
PreferenceDescription	New PreferenceDescription with default values

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

CreateDefaultPreferenceDescriptionLine()

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

Declaration

public PreferenceDescriptionLine CreateDefaultPreferenceDescriptionLine()

Returns

Type	Description
PreferenceDescriptionLine	New PreferenceDescriptionLine with default values

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

DeleteFromSectionAndKey(String, String)

Gets a PreferenceDescription based on the section and key

Declaration

public void DeleteFromSectionAndKey(string section, string key)

Parameters

Type	Name	Description
String	section	The PreferenceDescription-section
String	key	The PreferenceDescription-key

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

DeletePrefDescLinesByPrefDescId(Int32)

Delete the PrefDescLines associated with Preference Description Id in the SuperOffice database

Declaration

public void DeletePrefDescLinesByPrefDescId(int prefDescId)

Parameters

Type	Name	Description
Int32	prefDescId	Primary key of the Preference Description that contains PrefDescLines to delete

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

DeletePrefDescLinesByPrefDescIds(Int32[])

Delete the PrefDescLines associated with Preference Description Ids in the SuperOffice database

Declaration

public void DeletePrefDescLinesByPrefDescIds(int[] prefDescIds)

Parameters

Type	Name	Description
Int32[]	prefDescIds	Primary keys of the Preference Descriptions that contains PrefDescLines to delete

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

DeletePreference(Int32)

Delete a preference by id

Declaration

public void DeletePreference(int id)

Parameters

Type	Name	Description
Int32	id	The id of the preference to delete

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

DeletePreferenceDescription(Int32)

Deletes the PreferenceDescription

Declaration

public void DeletePreferenceDescription(int preferenceDescriptionId)

Parameters

Type	Name	Description
Int32	preferenceDescriptionId	The identity of the PreferenceDescription

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

DeletePreferenceDescriptionLine(Int32)

Deletes the PreferenceDescriptionLine

Declaration

public void DeletePreferenceDescriptionLine(int preferenceDescriptionLineId)

Parameters

Type	Name	Description
Int32	preferenceDescriptionLineId	The identity of the PreferenceDescriptionLine

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

DeletePreferenceDescriptionLines(Int32[])

Delete the PrefDescLines in the SuperOffice database

Declaration

public void DeletePreferenceDescriptionLines(int[] prefDescLineIds)

Parameters

Type	Name	Description
Int32[]	prefDescLineIds	Primary keys of the PrefDescLines to delete

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

DeletePreferences(Int32[])

Delete some preferences by id

Declaration

public void DeletePreferences(int[] ids)

Parameters

Type	Name	Description
Int32[]	ids	The ids of the preference to delete

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

GetAll()

Gets a list of all PreferenceDescriptions in the system.

Declaration

public PreferenceDescription[] GetAll()

Returns

Type	Description
PreferenceDescription[]	All PreferenceDescriptions in the system

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

GetAllFromSection(String)

Gets all PreferenceDescription-items in the specified section

Declaration

public PreferenceDescription[] GetAllFromSection(string section)

Parameters

Type	Name	Description
String	section	The PreferenceDescription-section

Returns

Type	Description
PreferenceDescription[]	All PreferenceDescriptions found.

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

GetFromSectionAndKey(String, String)

Gets a PreferenceDescription based on the section and key

Declaration

public PreferenceDescription GetFromSectionAndKey(string section, string key)

Parameters

Type	Name	Description
String	section	The PreferenceDescription-section
String	key	The PreferenceDescription-key

Returns

Type	Description
PreferenceDescription	A PreferenceDescription or null

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

GetNetServicesStatusUrl()

Returns URL to status service. e.g. 'https://help.superoffice.com/sodispatcher/v1/status' Returns NULL if status does not need to be checked yet.

Declaration

public string GetNetServicesStatusUrl()

Returns

Type	Description
String	NULL or URL of the status service that returns an XML or JSON block.

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

GetPreference(Int32)

Get a preference by id

Declaration

public Preference GetPreference(int id)

Parameters

Type	Name	Description
Int32	id	The id of the preference to load

Returns

Type	Description
Preference	The preference loaded

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

GetPreferenceByName(String, String, PreferenceLevel)

Get a preference by name

Declaration

public Preference GetPreferenceByName(string prefSection, string prefKey, PreferenceLevel prefLevel)

Parameters

Type	Name	Description
String	prefSection	The preference section name. e.g. 'Functions'. See SuperOffice.CRM.UserPreferenceStrings for constants.
String	prefKey	The preference key name. e.g. 'ShowTipsAtStart'. See SuperOffice.CRM.UserPreferenceStrings for constants.
PreferenceLevel	prefLevel	The preference level to read. Undefined (0) means to return the preference defined closest to the user.

Returns

Type	Description
Preference	The preference. Note that id = 0 and value = null if preference not found in the database at the requested pref-level.

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

GetPreferenceByNameAndId(String, String, PreferenceLevel, Int32)

Get a preference by name and owner id.

Declaration

public Preference GetPreferenceByNameAndId(string prefSection, string prefKey, PreferenceLevel prefLevel, int ownerId)

Parameters

Type	Name	Description
String	prefSection	The preference section name. e.g. 'Functions'. See SuperOffice.CRM.UserPreferenceStrings for constants.
String	prefKey	The preference key name. e.g. 'ShowTipsAtStart'. See SuperOffice.CRM.UserPreferenceStrings for constants.
PreferenceLevel	prefLevel	The preference level to read. Undefined (0) means to return the preference defined closest to the user.
Int32	ownerId	The preference owner id, individual or group.

Returns

Type	Description
Preference	The preference. Note that id = 0 and value = null if preference not found in the database at the requested pref-level.

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

GetPreferenceDescription(Int32)

Gets a PreferenceDescription object.

Declaration

public PreferenceDescription GetPreferenceDescription(int preferenceDescriptionId)

Parameters

Type	Name	Description
Int32	preferenceDescriptionId	The identifier of the PreferenceDescription object

Returns

Type	Description
PreferenceDescription	PreferenceDescription

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

GetPreferenceDescriptionLine(Int32)

Gets a PreferenceDescriptionLine object.

Declaration

public PreferenceDescriptionLine GetPreferenceDescriptionLine(int preferenceDescriptionLineId)

Parameters

Type	Name	Description
Int32	preferenceDescriptionLineId	The identifier of the PreferenceDescriptionLine object

Returns

Type	Description
PreferenceDescriptionLine	PreferenceDescriptionLine

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

GetPreferenceDescriptionLineFromIdAndValue(Int32, String)

Get a preference description line from a prefDesc_id and a prefValue

Declaration

public PreferenceDescriptionLine GetPreferenceDescriptionLineFromIdAndValue(int prefDescId, string prefValue)

Parameters

Type	Name	Description
Int32	prefDescId	The id of the preference description this line is connected to
String	prefValue	The value of the description line to return

Returns

Type	Description
PreferenceDescriptionLine	The preference description line matching the id and the value

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

GetPreferenceDescriptionLinesByPrefDescId(Int32)

Get all preference description lines from a prefDesc_id

Declaration

public PreferenceDescriptionLine[] GetPreferenceDescriptionLinesByPrefDescId(int prefDescId)

Parameters

Type	Name	Description
Int32	prefDescId	The id of the preference description this line is connected to

Returns

Type	Description
PreferenceDescriptionLine[]	The preference description lines matching the id

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

GetPreferences(PreferenceSpec[])

Get one or more preferences based on a set of specifications.<br/>The prefDisplayvalue and prefDisplaytooltip are blank (faster processing relative to GetPreferencesWithDisplayValues)

Declaration

public Preference[] GetPreferences(PreferenceSpec[] specifications)

Parameters

Type	Name	Description
PreferenceSpec[]	specifications	Array of preference specifications. The key value may be * (asterisk), which means 'all keys within section'. Note that the semantics of this are more strictly 'all keys actually set at any accessible level for this associate'; you will NOT get entries for preferences that might exist, but have no set value anywhere. You can also have askerisk as the section name. In that case the specification array must contain exactly one entry and the key must also be asterisk. This will return all known preferences in all sections for your associate. It might be a lot, tests have shown that a heavily used database can accumulate up to 500 preferences on a single associate. If the Sentry table/field right preferences have been used, the number could be a lot greater!

Returns

Type	Description
Preference[]	Array of preference values for your given specification(s). More strictly: 'all keys actually set at any accessible level for this associate'; you will NOT get entries for preferences that might exist, but have no set value anywhere.

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

GetPreferencesWithDisplayValues(PreferenceSpec[])

Get one or more preferences based on a set of specifications<br/>The PrefDisplayValue and PrefDisplaytooltip are populated, at some additional processing cost.

Declaration

public Preference[] GetPreferencesWithDisplayValues(PreferenceSpec[] specifications)

Parameters

Type	Name	Description
PreferenceSpec[]	specifications	Array of preference specifications. The key value may be * (asterisk), which means 'all keys within section'. Note that the semantics of this are more strictly 'all keys actually set at any accessible level for this associate'; you will NOT get entries for preferences that might exist, but have no set value anywhere. You can also have askerisk as the section name. In that case the specification array must contain exactly one entry and the key must also be asterisk. This will return all known preferences in all sections for your associate. It might be a lot, tests have shown that a heavily used database can accumulate up to 500 preferences on a single associate. If the Sentry table/field right preferences have been used, the number could be a lot greater!

Returns

Type	Description
Preference[]	Array of preference values for your given specification(s). More strictly: 'all keys actually set at any accessible level for this associate'; you will NOT get entries for preferences that might exist, but have no set value anywhere.<br/>The PrefDisplayValue and PrefDisplaytooltip are populated, at some additional processing cost.

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

GetTabOrder(String)

Gets the tab order.

Declaration

public TabOrder GetTabOrder(string tabName)

Parameters

Type	Name	Description
String	tabName	Name of the tab control

Returns

Type	Description
TabOrder	Tab order. Array of strings. Each string represent a named tab.

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

GetTabOrders()

Facade for the Preference Agent Preferences, user interface tab configuration

Declaration

public TabOrder[] GetTabOrders()

Returns

Type	Description
TabOrder[]

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

GetXsrfPaths(String)

Returns paths that XSRF cookies should be set on

Declaration

public string[] GetXsrfPaths(string hostname)

Parameters

Type	Name	Description
String	hostname	The hostname that we are storing paths for.

Returns

Type	Description
String[]	Paths that XSRF cookies should be set for: ['/cs', '/crm']

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

SaveFromSectionAndKey(String, String, PreferenceDescription)

Update a PreferenceDescription based on the section and key

Declaration

public PreferenceDescription SaveFromSectionAndKey(string section, string key, PreferenceDescription preferenceDescription)

Parameters

Type	Name	Description
String	section	The PreferenceDescription-section
String	key	The PreferenceDescription-key
PreferenceDescription	preferenceDescription	The PreferenceDescription to save.

Returns

Type	Description
PreferenceDescription	Saved PreferenceDescription

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

SavePreference(Preference)

Save this preference

Declaration

public void SavePreference(Preference preference)

Parameters

Type	Name	Description
Preference	preference	Preference to be saved. All fields must be filled in, and the preference will be saved on the Associate level only. Setting for other levels is an administrative task and not available through this service.

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

SavePreferenceDescription(PreferenceDescription)

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

Declaration

public PreferenceDescription SavePreferenceDescription(PreferenceDescription preferenceDescription)

Parameters

Type	Name	Description
PreferenceDescription	preferenceDescription	The PreferenceDescription that is saved.

Returns

Type	Description
PreferenceDescription	New or updated PreferenceDescription

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

SavePreferenceDescriptionLine(PreferenceDescriptionLine)

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

Declaration

public PreferenceDescriptionLine SavePreferenceDescriptionLine(PreferenceDescriptionLine preferenceDescriptionLine)

Parameters

Type	Name	Description
PreferenceDescriptionLine	preferenceDescriptionLine	The PreferenceDescriptionLine that is saved.

Returns

Type	Description
PreferenceDescriptionLine	New or updated PreferenceDescriptionLine

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

SavePreferenceDescriptionLines(PreferenceDescriptionLine[])

Saves the PreferenceDescriptionLine array in the SuperOffice database

Declaration

public PreferenceDescriptionLine[] SavePreferenceDescriptionLines(PreferenceDescriptionLine[] preferenceDescriptionLines)

Parameters

Type	Name	Description
PreferenceDescriptionLine[]	preferenceDescriptionLines	The PreferenceDescriptionLine array to save.

Returns

Type	Description
PreferenceDescriptionLine[]	The updated PrefDesc lines (If the PreferenceDescriptionLine array was new, it returns with id's set.

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

SavePreferenceEntities(Preference[], Boolean)

Save this set of preferences.

Declaration

public void SavePreferenceEntities(Preference[] preferences, bool removeLowerLevels)

Parameters

Type	Name	Description
Preference[]	preferences	Preferences to be saved. Note that all fields must be filled in.
Boolean	removeLowerLevels	If this is true, all user preferences on lower levels will be deleted

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

SavePreferenceEntity(Preference, Boolean)

Saves a complete preference object, on any level and any target. Preference administrator rights are required to use this

Declaration

public Preference SavePreferenceEntity(Preference preference, bool removeLowerLevels)

Parameters

Type	Name	Description
Preference	preference	The preference object to be saved
Boolean	removeLowerLevels	If this is true, all user preferences on lower levels will be deleted

Returns

Type	Description
Preference	Returns the saved preference

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

SavePreferences(Preference[])

Save this set of preferences. Note this method DOES NOT look at level/targetId - it only saves on behalf of the CURRENT USER.

Declaration

public void SavePreferences(Preference[] preferences)

Parameters

Type	Name	Description
Preference[]	preferences	Preferences to be saved. Note that all fields must be filled in, and the preference will be saved on the Associate level only! Setting for other levels is an administrative task and not available through this service.

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

SaveTabOrder(TabOrder)

Saves the tab order. The order is saved pr. user.

Declaration

public void SaveTabOrder(TabOrder tabOrder)

Parameters

Type	Name	Description
TabOrder	tabOrder	Name of the tab control

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

SaveTabOrders(TabOrder[])

Facade for the Preference Agent Preferences, user interface tab configuration

Declaration

public void SaveTabOrders(TabOrder[] tabOrders)

Parameters

Type	Name	Description
TabOrder[]	tabOrders

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

SetXsrfPaths(String, String[])

Update the paths that need XSRF cookies

Declaration

public void SetXsrfPaths(string hostname, string[] paths)

Parameters

Type	Name	Description
String	hostname	The hostname that we are storing paths for.
String[]	paths	Paths that XSRF cookies should be set for: ['/cs', '/crm']

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

UpdateNetServicesStatus(String)

Update the NetServices preferences with values contained in the content from the Status URL

Declaration

public void UpdateNetServicesStatus(string xml_or_json)

Parameters

Type	Name	Description
String	xml_or_json	The text that was returned by getting the Status URL

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

Implements

System.IDisposable

IPreferenceAgent

IAgent