Class NSPreferenceAgent

NSPreferenceAgent()

Preferences, user interface tab configuration.

Declaration

NSPreferenceAgent

NSPreferenceAgent agent;
agent.callMethod(arg1, arg2);

CreateDefaultPreference()

Sets default values into a new NSPreference.

Declaration

NSPreference CreateDefaultPreference()

NSPreferenceAgent agent;
NSPreference thing = agent.CreateDefaultPreference();
thing = agent.SavePreference(thing);

Returns

CreateDefaultPreferenceDescription()

Sets default values into a new NSPreferenceDescription.

Declaration

NSPreferenceDescription CreateDefaultPreferenceDescription()

NSPreferenceAgent agent;
NSPreferenceDescription thing = agent.CreateDefaultPreferenceDescription();
thing = agent.SavePreferenceDescription(thing);

Returns

CreateDefaultPreferenceDescriptionLine()

Sets default values into a new NSPreferenceDescriptionLine.

Declaration

NSPreferenceDescriptionLine CreateDefaultPreferenceDescriptionLine()

NSPreferenceAgent agent;
NSPreferenceDescriptionLine thing = agent.CreateDefaultPreferenceDescriptionLine();
thing = agent.SavePreferenceDescriptionLine(thing);

Returns

DeleteFromSectionAndKey(String,String)

Gets an NSPreferenceDescription based on the section and key

Declaration

Void DeleteFromSectionAndKey(String section, String key)

NSPreferenceAgent agent;
String section;
String key;
agent.DeleteFromSectionAndKey(section, key);

Parameters

Returns

DeletePrefDescLinesByPrefDescId(Integer)

Deletes the PrefDescLines associated with Preference Description ID in the SuperOffice database

Declaration

Void DeletePrefDescLinesByPrefDescId(Integer prefDescId)

NSPreferenceAgent agent;
Integer prefDescId;
agent.DeletePrefDescLinesByPrefDescId(prefDescId);

Parameters

Returns

DeletePrefDescLinesByPrefDescIds(Integer[])

Deletes the PrefDescLines associated with Preference Description IDs in the SuperOffice database

Declaration

Void DeletePrefDescLinesByPrefDescIds(Integer[] prefDescIds)

NSPreferenceAgent agent;
Integer[] prefDescIds;
agent.DeletePrefDescLinesByPrefDescIds(prefDescIds);

Parameters

Returns

DeletePreference(Integer)

Deletes a preference by ID

Declaration

Void DeletePreference(Integer id)

NSPreferenceAgent agent;
Integer id;
agent.DeletePreference(id);

Parameters

Returns

DeletePreferenceDescription(Integer)

Deletes the NSPreferenceDescription

Declaration

DeletePreferenceDescription(Integer preferenceDescription)

NSPreferenceAgent agent;
agent.DeletePreferenceDescription(123);

Parameters

Returns

DeletePreferenceDescriptionLine(Integer)

Deletes the NSPreferenceDescriptionLine

Declaration

DeletePreferenceDescriptionLine(Integer preferenceDescriptionLine)

NSPreferenceAgent agent;
agent.DeletePreferenceDescriptionLine(123);

Parameters

Returns

DeletePreferenceDescriptionLines(Integer[])

Deletes the PrefDescLines in the SuperOffice database

Declaration

Void DeletePreferenceDescriptionLines(Integer[] prefDescLineIds)

NSPreferenceAgent agent;
Integer[] prefDescLineIds;
agent.DeletePreferenceDescriptionLines(prefDescLineIds);

Parameters

Returns

DeletePreferences(Integer[])

Deletes some preferences by ID

Declaration

Void DeletePreferences(Integer[] ids)

NSPreferenceAgent agent;
Integer[] ids;
agent.DeletePreferences(ids);

Parameters

Returns

GetAll()

Gets a list of all PreferenceDescriptions in the system.

Declaration

NSPreferenceDescription[] GetAll()

NSPreferenceAgent agent;
NSPreferenceDescription[] res = agent.GetAll();

Returns

GetAllFromSection(String)

Gets all NSPreferenceDescription-items in the specified section

Declaration

NSPreferenceDescription[] GetAllFromSection(String section)

NSPreferenceAgent agent;
String section;
NSPreferenceDescription[] res = agent.GetAllFromSection(section);

Parameters

Returns

GetFromSectionAndKey(String,String)

Gets an NSPreferenceDescription based on the section and key

Declaration

NSPreferenceDescription GetFromSectionAndKey(String section, String key)

NSPreferenceAgent agent;
String section;
String key;
NSPreferenceDescription res = agent.GetFromSectionAndKey(section, key);

Parameters

Returns

GetNetServicesStatusUrl()

Returns URL to status service. e.g. 'https://help.superoffice.com/sodispatcher/v1/status'

Declaration

String GetNetServicesStatusUrl()

NSPreferenceAgent agent;
String res = agent.GetNetServicesStatusUrl();

Returns

GetPreference(Integer)

Gets a preference by ID

Declaration

NSPreference GetPreference(Integer id)

NSPreferenceAgent agent;
Integer id;
NSPreference res = agent.GetPreference(id);

Parameters

Returns

GetPreferenceByName(String,String,Integer)

Gets a preference by name

Declaration

NSPreference GetPreferenceByName(String prefSection, String prefKey, Integer prefLevel)

NSPreferenceAgent agent;
String prefSection;
String prefKey;
Integer prefLevel;
NSPreference res = agent.GetPreferenceByName(prefSection, prefKey, prefLevel);

Parameters

Returns

GetPreferenceByNameAndId(String,String,Integer,Integer)

Gets a preference by name and owner ID.

Declaration

NSPreference GetPreferenceByNameAndId(String prefSection, String prefKey, Integer prefLevel, Integer ownerId)

NSPreferenceAgent agent;
String prefSection;
String prefKey;
Integer prefLevel;
Integer ownerId;
NSPreference res = agent.GetPreferenceByNameAndId(prefSection, prefKey, prefLevel, ownerId);

Parameters

Returns

GetPreferenceDescription(Integer)

Gets an NSPreferenceDescription object.

Declaration

NSPreferenceDescription GetPreferenceDescription(Integer preferenceDescriptionId)

NSPreferenceAgent agent;
NSPreferenceDescription thing = agent.GetPreferenceDescription(123);

Parameters

Returns

GetPreferenceDescriptionLine(Integer)

Gets an NSPreferenceDescriptionLine object.

Declaration

NSPreferenceDescriptionLine GetPreferenceDescriptionLine(Integer preferenceDescriptionLineId)

NSPreferenceAgent agent;
NSPreferenceDescriptionLine thing = agent.GetPreferenceDescriptionLine(123);

Parameters

Returns

GetPreferenceDescriptionLineFromIdAndValue(Integer,String)

Gets a preference description line from a prefDesc_id and a prefValue

Declaration

NSPreferenceDescriptionLine GetPreferenceDescriptionLineFromIdAndValue(Integer prefDescId, String prefValue)

NSPreferenceAgent agent;
Integer prefDescId;
String prefValue;
NSPreferenceDescriptionLine res = agent.GetPreferenceDescriptionLineFromIdAndValue(prefDescId, prefValue);

Parameters

Returns

GetPreferenceDescriptionLinesByPrefDescId(Integer)

Gets all preference description lines from a prefDesc_id

Declaration

NSPreferenceDescriptionLine[] GetPreferenceDescriptionLinesByPrefDescId(Integer prefDescId)

NSPreferenceAgent agent;
Integer prefDescId;
NSPreferenceDescriptionLine[] res = agent.GetPreferenceDescriptionLinesByPrefDescId(prefDescId);

Parameters

Returns

GetPreferences(NSPreferenceSpec[])

Gets one or more preferences based on a set of specifications.

Declaration

NSPreference[] GetPreferences(NSPreferenceSpec[] specifications)

NSPreferenceAgent agent;
NSPreferenceSpec[] specifications;
NSPreference[] res = agent.GetPreferences(specifications);

Parameters

Returns

GetPreferencesWithDisplayValues(NSPreferenceSpec[])

Gets one or more preferences based on a set of specifications.

Declaration

NSPreference[] GetPreferencesWithDisplayValues(NSPreferenceSpec[] specifications)

NSPreferenceAgent agent;
NSPreferenceSpec[] specifications;
NSPreference[] res = agent.GetPreferencesWithDisplayValues(specifications);

Parameters

Returns

GetTabOrder(String)

Gets the tab order.

Declaration

NSTabOrder GetTabOrder(String tabName)

NSPreferenceAgent agent;
String tabName;
NSTabOrder res = agent.GetTabOrder(tabName);

Parameters

Returns

GetTabOrders()

Declaration

NSTabOrder[] GetTabOrders()

Returns

SaveFromSectionAndKey(String,String,NSPreferenceDescription)

Updates an NSPreferenceDescription based on the section and key

Declaration

NSPreferenceDescription SaveFromSectionAndKey(String section, String key, NSPreferenceDescription preferenceDescription)

NSPreferenceAgent agent;
String section;
String key;
NSPreferenceDescription preferenceDescription;
NSPreferenceDescription res = agent.SaveFromSectionAndKey(section, key, preferenceDescription);

Parameters

Returns

SavePreference(NSPreference)

Saves this preference

Declaration

Void SavePreference(NSPreference preference)

NSPreferenceAgent agent;
NSPreference preference;
agent.SavePreference(preference);

Parameters

Returns

SavePreferenceDescription(NSPreferenceDescription)

Updates the existing NSPreferenceDescription or creates a new NSPreferenceDescription if the id parameter is 0

Declaration

NSPreferenceDescription SavePreferenceDescription(NSPreferenceDescription preferenceDescription)

NSPreference  agent;
NSPreferenceDescription thing = agent.CreateDefaultPreferenceDescription();
thing = agent.SavePreferenceDescription(thing);

Parameters

Returns

SavePreferenceDescriptionLine(NSPreferenceDescriptionLine)

Updates the existing NSPreferenceDescriptionLine or creates a new NSPreferenceDescriptionLine if the id parameter is 0

Declaration

NSPreferenceDescriptionLine SavePreferenceDescriptionLine(NSPreferenceDescriptionLine preferenceDescriptionLine)

NSPreference  agent;
NSPreferenceDescriptionLine thing = agent.CreateDefaultPreferenceDescriptionLine();
thing = agent.SavePreferenceDescriptionLine(thing);

Parameters

Returns

SavePreferenceDescriptionLines(NSPreferenceDescriptionLine[])

Saves the PreferenceDescriptionLine array in the SuperOffice database

Declaration

NSPreferenceDescriptionLine[] SavePreferenceDescriptionLines(NSPreferenceDescriptionLine[] preferenceDescriptionLines)

NSPreferenceAgent agent;
NSPreferenceDescriptionLine[] preferenceDescriptionLines;
NSPreferenceDescriptionLine[] res = agent.SavePreferenceDescriptionLines(preferenceDescriptionLines);

Parameters

Returns

SavePreferenceEntities(NSPreference[],Bool)

Saves this set of preferences.

Declaration

Void SavePreferenceEntities(NSPreference[] preferences, Bool removeLowerLevels)

Parameters

Returns

SavePreferenceEntity(NSPreference,Bool)

Saves a complete preference object, on any level and any target.

Declaration

NSPreference SavePreferenceEntity(NSPreference preference, Bool removeLowerLevels)

NSPreferenceAgent agent;
NSPreference preference;
Bool removeLowerLevels;
NSPreference res = agent.SavePreferenceEntity(preference, removeLowerLevels);

Parameters

Returns

SavePreferences(NSPreference[])

Saves this set of preferences.

Declaration

Void SavePreferences(NSPreference[] preferences)

Parameters

Returns

SaveTabOrder(NSTabOrder)

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

Declaration

Void SaveTabOrder(NSTabOrder tabOrder)

NSPreferenceAgent agent;
NSTabOrder tabOrder;
agent.SaveTabOrder(tabOrder);

Parameters

Returns

SaveTabOrders(NSTabOrder[])

Declaration

Void SaveTabOrders(NSTabOrder[] tabOrders)

Parameters

Returns

UpdateNetServicesStatus(String)

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

Declaration

Void UpdateNetServicesStatus(String xmlOrJson)

NSPreferenceAgent agent;
String xmlOrJson;
agent.UpdateNetServicesStatus(xmlOrJson);

Parameters

Returns