Class NSPreferenceAgent
Preferences, user interface tab configuration.
Syntax
Examples
NSPreferenceAgent agent;
agent.callMethod(arg1, arg2);
Constructors
NSPreferenceAgent()
Preferences, user interface tab configuration.
Introduced or updated in version: 7
Declaration
NSPreferenceAgent
Examples
NSPreferenceAgent agent;
agent.callMethod(arg1, arg2);
Methods
CreateDefaultPreference()
Sets default values into a new NSPreference.
Introduced or updated in version: 7
Declaration
NSPreference CreateDefaultPreference()
Returns
Type | Description |
---|---|
NSPreference |
Remarks
NetServer calculates default values (for example, Country) on the entity, which is required when creating/storing a new instance
Examples
NSPreferenceAgent agent;
NSPreference thing = agent.CreateDefaultPreference();
thing = agent.SavePreference(thing);
CreateDefaultPreferenceDescription()
Sets default values into a new NSPreferenceDescription.
Introduced or updated in version: 7.5
Declaration
NSPreferenceDescription CreateDefaultPreferenceDescription()
Returns
Type | Description |
---|---|
NSPreferenceDescription |
Remarks
NetServer calculates default values (for example, Country) on the entity, which is required when creating/storing a new instance
Examples
NSPreferenceAgent agent;
NSPreferenceDescription thing = agent.CreateDefaultPreferenceDescription();
thing = agent.SavePreferenceDescription(thing);
CreateDefaultPreferenceDescriptionLine()
Sets default values into a new NSPreferenceDescriptionLine.
Introduced or updated in version: 7.5
Declaration
NSPreferenceDescriptionLine CreateDefaultPreferenceDescriptionLine()
Returns
Type | Description |
---|---|
NSPreferenceDescriptionLine |
Remarks
NetServer calculates default values (for example, Country) on the entity, which is required when creating/storing a new instance
Examples
NSPreferenceAgent agent;
NSPreferenceDescriptionLine thing = agent.CreateDefaultPreferenceDescriptionLine();
thing = agent.SavePreferenceDescriptionLine(thing);
DeleteFromSectionAndKey(String,String)
Gets an NSPreferenceDescription based on the section and key
Introduced or updated in version: 8.2
Declaration
Void DeleteFromSectionAndKey(String section, String key)
Parameters
Type | Name | Description |
---|---|---|
String | section | |
String | key |
Returns
Type | Description |
---|---|
Void |
Examples
NSPreferenceAgent agent;
String section;
String key;
agent.DeleteFromSectionAndKey(section, key);
DeletePrefDescLinesByPrefDescId(Integer)
Deletes the PrefDescLines associated with Preference Description ID in the SuperOffice database
Introduced or updated in version: 7
Declaration
Void DeletePrefDescLinesByPrefDescId(Integer prefDescId)
Parameters
Type | Name | Description |
---|---|---|
Integer | prefDescId |
Returns
Type | Description |
---|---|
Void |
Examples
NSPreferenceAgent agent;
Integer prefDescId;
agent.DeletePrefDescLinesByPrefDescId(prefDescId);
DeletePrefDescLinesByPrefDescIds(Integer[])
Deletes the PrefDescLines associated with Preference Description IDs in the SuperOffice database
Introduced or updated in version: 7
Declaration
Void DeletePrefDescLinesByPrefDescIds(Integer[] prefDescIds)
Parameters
Type | Name | Description |
---|---|---|
Integer[] | prefDescIds |
Returns
Type | Description |
---|---|
Void |
Examples
NSPreferenceAgent agent;
Integer[] prefDescIds;
agent.DeletePrefDescLinesByPrefDescIds(prefDescIds);
DeletePreference(Integer)
Deletes a preference by ID
Introduced or updated in version: 7.5
Declaration
Void DeletePreference(Integer id)
Parameters
Type | Name | Description |
---|---|---|
Integer | id |
Returns
Type | Description |
---|---|
Void |
Examples
NSPreferenceAgent agent;
Integer id;
agent.DeletePreference(id);
DeletePreferenceDescription(Integer)
Deletes the NSPreferenceDescription
Introduced or updated in version: 8.2
Declaration
DeletePreferenceDescription(Integer preferenceDescription)
Parameters
Type | Name | Description |
---|---|---|
Integer | preferenceDescription |
Returns
Type | Description |
---|---|
Void |
Examples
NSPreferenceAgent agent;
agent.DeletePreferenceDescription(123);
DeletePreferenceDescriptionLine(Integer)
Deletes the NSPreferenceDescriptionLine
Introduced or updated in version: 7
Declaration
DeletePreferenceDescriptionLine(Integer preferenceDescriptionLine)
Parameters
Type | Name | Description |
---|---|---|
Integer | preferenceDescriptionLine |
Returns
Type | Description |
---|---|
Void |
Examples
NSPreferenceAgent agent;
agent.DeletePreferenceDescriptionLine(123);
DeletePreferenceDescriptionLines(Integer[])
Deletes the PrefDescLines in the SuperOffice database
Introduced or updated in version: 7
Declaration
Void DeletePreferenceDescriptionLines(Integer[] prefDescLineIds)
Parameters
Type | Name | Description |
---|---|---|
Integer[] | prefDescLineIds |
Returns
Type | Description |
---|---|
Void |
Examples
NSPreferenceAgent agent;
Integer[] prefDescLineIds;
agent.DeletePreferenceDescriptionLines(prefDescLineIds);
DeletePreferences(Integer[])
Deletes some preferences by ID
Introduced or updated in version: 7.5
Declaration
Void DeletePreferences(Integer[] ids)
Parameters
Type | Name | Description |
---|---|---|
Integer[] | ids |
Returns
Type | Description |
---|---|
Void |
Examples
NSPreferenceAgent agent;
Integer[] ids;
agent.DeletePreferences(ids);
GetAll()
Gets a list of all PreferenceDescriptions in the system.
Introduced or updated in version: 8.2
Declaration
NSPreferenceDescription[] GetAll()
Returns
Type | Description |
---|---|
NSPreferenceDescription[] |
Examples
NSPreferenceAgent agent;
NSPreferenceDescription[] res = agent.GetAll();
GetAllFromSection(String)
Gets all NSPreferenceDescription-items in the specified section
Introduced or updated in version: 8.2
Declaration
NSPreferenceDescription[] GetAllFromSection(String section)
Parameters
Type | Name | Description |
---|---|---|
String | section |
Returns
Type | Description |
---|---|
NSPreferenceDescription[] |
Examples
NSPreferenceAgent agent;
String section;
NSPreferenceDescription[] res = agent.GetAllFromSection(section);
GetFromSectionAndKey(String,String)
Gets an NSPreferenceDescription based on the section and key
Introduced or updated in version: 8.2
Declaration
NSPreferenceDescription GetFromSectionAndKey(String section, String key)
Parameters
Type | Name | Description |
---|---|---|
String | section | |
String | key |
Returns
Type | Description |
---|---|
NSPreferenceDescription |
Examples
NSPreferenceAgent agent;
String section;
String key;
NSPreferenceDescription res = agent.GetFromSectionAndKey(section, key);
GetNetServicesStatusUrl()
Returns URL to status service. e.g. 'https://help.superoffice.com/sodispatcher/v1/status'
Introduced or updated in version: 8.0sr3
Declaration
String GetNetServicesStatusUrl()
Returns
Type | Description |
---|---|
String | URL; NULL if status does not need to be checked yet. |
Examples
NSPreferenceAgent agent;
String res = agent.GetNetServicesStatusUrl();
GetPreference(Integer)
Gets a preference by ID
Introduced or updated in version: 7.5
Declaration
NSPreference GetPreference(Integer id)
Parameters
Type | Name | Description |
---|---|---|
Integer | id |
Returns
Type | Description |
---|---|
NSPreference |
Examples
NSPreferenceAgent agent;
Integer id;
NSPreference res = agent.GetPreference(id);
GetPreferenceByName(String,String,Integer)
Gets a preference by name
Introduced or updated in version: 8.0sr3
Declaration
NSPreference GetPreferenceByName(String prefSection, String prefKey, Integer prefLevel)
Parameters
Type | Name | Description |
---|---|---|
String | prefSection | |
String | prefKey | |
Integer | prefLevel | See PreferenceLevel. |
Returns
Type | Description |
---|---|
NSPreference |
Examples
NSPreferenceAgent agent;
String prefSection;
String prefKey;
Integer prefLevel;
NSPreference res = agent.GetPreferenceByName(prefSection, prefKey, prefLevel);
GetPreferenceByNameAndId(String,String,Integer,Integer)
Gets a preference by name and owner ID.
Introduced or updated in version: 8.5R08
Declaration
NSPreference GetPreferenceByNameAndId(String prefSection, String prefKey, Integer prefLevel, Integer ownerId)
Parameters
Type | Name | Description |
---|---|---|
String | prefSection | |
String | prefKey | |
Integer | prefLevel | See PreferenceLevel. |
Integer | ownerId |
Returns
Type | Description |
---|---|
NSPreference |
Examples
NSPreferenceAgent agent;
String prefSection;
String prefKey;
Integer prefLevel;
Integer ownerId;
NSPreference res = agent.GetPreferenceByNameAndId(prefSection, prefKey, prefLevel, ownerId);
GetPreferenceDescription(Integer)
Gets an NSPreferenceDescription object.
Introduced or updated in version: 7.5
Declaration
NSPreferenceDescription GetPreferenceDescription(Integer preferenceDescriptionId)
Parameters
Type | Name | Description |
---|---|---|
Integer | preferenceDescriptionId |
Returns
Type | Description |
---|---|
NSPreferenceDescription |
Examples
NSPreferenceAgent agent;
NSPreferenceDescription thing = agent.GetPreferenceDescription(123);
GetPreferenceDescriptionLine(Integer)
Gets an NSPreferenceDescriptionLine object.
Introduced or updated in version: 7.5
Declaration
NSPreferenceDescriptionLine GetPreferenceDescriptionLine(Integer preferenceDescriptionLineId)
Parameters
Type | Name | Description |
---|---|---|
Integer | preferenceDescriptionLineId |
Returns
Type | Description |
---|---|
NSPreferenceDescriptionLine |
Examples
NSPreferenceAgent agent;
NSPreferenceDescriptionLine thing = agent.GetPreferenceDescriptionLine(123);
GetPreferenceDescriptionLineFromIdAndValue(Integer,String)
Gets a preference description line from a prefDesc_id and a prefValue
Introduced or updated in version: 7.5
Declaration
NSPreferenceDescriptionLine GetPreferenceDescriptionLineFromIdAndValue(Integer prefDescId, String prefValue)
Parameters
Type | Name | Description |
---|---|---|
Integer | prefDescId | |
String | prefValue |
Returns
Type | Description |
---|---|
NSPreferenceDescriptionLine |
Examples
NSPreferenceAgent agent;
Integer prefDescId;
String prefValue;
NSPreferenceDescriptionLine res = agent.GetPreferenceDescriptionLineFromIdAndValue(prefDescId, prefValue);
GetPreferenceDescriptionLinesByPrefDescId(Integer)
Gets all preference description lines from a prefDesc_id
Introduced or updated in version: 7
Declaration
NSPreferenceDescriptionLine[] GetPreferenceDescriptionLinesByPrefDescId(Integer prefDescId)
Parameters
Type | Name | Description |
---|---|---|
Integer | prefDescId |
Returns
Type | Description |
---|---|
NSPreferenceDescriptionLine[] |
Examples
NSPreferenceAgent agent;
Integer prefDescId;
NSPreferenceDescriptionLine[] res = agent.GetPreferenceDescriptionLinesByPrefDescId(prefDescId);
GetPreferences(NSPreferenceSpec[])
Gets one or more preferences based on a set of specifications.
Introduced or updated in version: 7
Declaration
NSPreference[] GetPreferences(NSPreferenceSpec[] specifications)
Parameters
Type | Name | Description |
---|---|---|
NSPreferenceSpec[] | specifications |
Returns
Type | Description |
---|---|
NSPreference[] |
Remarks
The prefDisplayvalue and prefDisplaytooltip are blank (faster processing relative to GetPreferencesWithDisplayValues)
Examples
NSPreferenceAgent agent;
NSPreferenceSpec[] specifications;
NSPreference[] res = agent.GetPreferences(specifications);
GetPreferencesWithDisplayValues(NSPreferenceSpec[])
Gets one or more preferences based on a set of specifications.
Introduced or updated in version: 7
Declaration
NSPreference[] GetPreferencesWithDisplayValues(NSPreferenceSpec[] specifications)
Parameters
Type | Name | Description |
---|---|---|
NSPreferenceSpec[] | specifications |
Returns
Type | Description |
---|---|
NSPreference[] |
Remarks
The PrefDisplayValue and PrefDisplaytooltip are populated, at some additional processing cost.
Examples
NSPreferenceAgent agent;
NSPreferenceSpec[] specifications;
NSPreference[] res = agent.GetPreferencesWithDisplayValues(specifications);
GetTabOrder(String)
Gets the tab order.
Introduced or updated in version: 7
Declaration
NSTabOrder GetTabOrder(String tabName)
Parameters
Type | Name | Description |
---|---|---|
String | tabName |
Returns
Type | Description |
---|---|
NSTabOrder |
Examples
NSPreferenceAgent agent;
String tabName;
NSTabOrder res = agent.GetTabOrder(tabName);
GetTabOrders()
Introduced or updated in version: 7
Declaration
NSTabOrder[] GetTabOrders()
Returns
Type | Description |
---|---|
NSTabOrder[] |
SaveFromSectionAndKey(String,String,NSPreferenceDescription)
Updates an NSPreferenceDescription based on the section and key
Introduced or updated in version: 8.2
Declaration
NSPreferenceDescription SaveFromSectionAndKey(String section, String key, NSPreferenceDescription preferenceDescription)
Parameters
Type | Name | Description |
---|---|---|
String | section | |
String | key | |
NSPreferenceDescription | preferenceDescription |
Returns
Type | Description |
---|---|
NSPreferenceDescription |
Examples
NSPreferenceAgent agent;
String section;
String key;
NSPreferenceDescription preferenceDescription;
NSPreferenceDescription res = agent.SaveFromSectionAndKey(section, key, preferenceDescription);
SavePreference(NSPreference)
Saves this preference
Introduced or updated in version: 7
Declaration
Void SavePreference(NSPreference preference)
Parameters
Type | Name | Description |
---|---|---|
NSPreference | preference |
Returns
Type | Description |
---|---|
Void |
Examples
NSPreferenceAgent agent;
NSPreference preference;
agent.SavePreference(preference);
SavePreferenceDescription(NSPreferenceDescription)
Updates the existing NSPreferenceDescription or creates a new NSPreferenceDescription if the id parameter is 0
Introduced or updated in version: 7.5
Declaration
NSPreferenceDescription SavePreferenceDescription(NSPreferenceDescription preferenceDescription)
Parameters
Type | Name | Description |
---|---|---|
NSPreferenceDescription | preferenceDescription |
Returns
Type | Description |
---|---|
NSPreferenceDescription |
Examples
NSPreference agent;
NSPreferenceDescription thing = agent.CreateDefaultPreferenceDescription();
thing = agent.SavePreferenceDescription(thing);
SavePreferenceDescriptionLine(NSPreferenceDescriptionLine)
Updates the existing NSPreferenceDescriptionLine or creates a new NSPreferenceDescriptionLine if the id parameter is 0
Introduced or updated in version: 7
Declaration
NSPreferenceDescriptionLine SavePreferenceDescriptionLine(NSPreferenceDescriptionLine preferenceDescriptionLine)
Parameters
Type | Name | Description |
---|---|---|
NSPreferenceDescriptionLine | preferenceDescriptionLine |
Returns
Type | Description |
---|---|
NSPreferenceDescriptionLine |
Examples
NSPreference agent;
NSPreferenceDescriptionLine thing = agent.CreateDefaultPreferenceDescriptionLine();
thing = agent.SavePreferenceDescriptionLine(thing);
SavePreferenceDescriptionLines(NSPreferenceDescriptionLine[])
Saves the PreferenceDescriptionLine array in the SuperOffice database
Introduced or updated in version: 7
Declaration
NSPreferenceDescriptionLine[] SavePreferenceDescriptionLines(NSPreferenceDescriptionLine[] preferenceDescriptionLines)
Parameters
Type | Name | Description |
---|---|---|
NSPreferenceDescriptionLine[] | preferenceDescriptionLines |
Returns
Type | Description |
---|---|
NSPreferenceDescriptionLine[] |
Examples
NSPreferenceAgent agent;
NSPreferenceDescriptionLine[] preferenceDescriptionLines;
NSPreferenceDescriptionLine[] res = agent.SavePreferenceDescriptionLines(preferenceDescriptionLines);
SavePreferenceEntities(NSPreference[],Bool)
Saves this set of preferences.
Introduced or updated in version: 8.5R08
Declaration
Void SavePreferenceEntities(NSPreference[] preferences, Bool removeLowerLevels)
Parameters
Type | Name | Description |
---|---|---|
NSPreference[] | preferences | |
Bool | removeLowerLevels |
Returns
Type | Description |
---|---|
Void |
SavePreferenceEntity(NSPreference,Bool)
Saves a complete preference object, on any level and any target.
Introduced or updated in version: 7.5
Declaration
NSPreference SavePreferenceEntity(NSPreference preference, Bool removeLowerLevels)
Parameters
Type | Name | Description |
---|---|---|
NSPreference | preference | |
Bool | removeLowerLevels |
Returns
Type | Description |
---|---|
NSPreference |
Remarks
Preference administrator rights are required to use this
Examples
NSPreferenceAgent agent;
NSPreference preference;
Bool removeLowerLevels;
NSPreference res = agent.SavePreferenceEntity(preference, removeLowerLevels);
SavePreferences(NSPreference[])
Saves this set of preferences.
Introduced or updated in version: 7
Declaration
Void SavePreferences(NSPreference[] preferences)
Parameters
Type | Name | Description |
---|---|---|
NSPreference[] | preferences |
Returns
Type | Description |
---|---|
Void |
Remarks
DOES NOT look at level/targetId, it only saves on behalf of the CURRENT USER.
SaveTabOrder(NSTabOrder)
Saves the tab order. The order is saved pr. user.
Introduced or updated in version: 7
Declaration
Void SaveTabOrder(NSTabOrder tabOrder)
Parameters
Type | Name | Description |
---|---|---|
NSTabOrder | tabOrder |
Returns
Type | Description |
---|---|
Void |
Examples
NSPreferenceAgent agent;
NSTabOrder tabOrder;
agent.SaveTabOrder(tabOrder);
SaveTabOrders(NSTabOrder[])
Introduced or updated in version: 7
Declaration
Void SaveTabOrders(NSTabOrder[] tabOrders)
Parameters
Type | Name | Description |
---|---|---|
NSTabOrder[] | tabOrders |
Returns
Type | Description |
---|---|
Void |
UpdateNetServicesStatus(String)
Updates the NetServices preferences with values contained in the content from the Status URL
Introduced or updated in version: 8.0sr3
Declaration
Void UpdateNetServicesStatus(String xmlOrJson)
Parameters
Type | Name | Description |
---|---|---|
String | xmlOrJson |
Returns
Type | Description |
---|---|
Void |
Examples
NSPreferenceAgent agent;
String xmlOrJson;
agent.UpdateNetServicesStatus(xmlOrJson);