NSPreferenceAgent - SuperOffice

Preferences, user interface tab configuration.

Constructors

NSPreferenceAgent()

NSPreferenceAgent

Preferences, user interface tab configuration.

Methods

CreateDefaultPreference()

Sets default values into a new NSPreference.

NSPreference CreateDefaultPreference()

Returns: CRMScript.NetServer.NSPreference

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

Example:

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

CreateDefaultPreferenceDescription()

Sets default values into a new NSPreferenceDescription.

NSPreferenceDescription CreateDefaultPreferenceDescription()

Returns: CRMScript.NetServer.NSPreferenceDescription

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

Example:

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

CreateDefaultPreferenceDescriptionLine()

Sets default values into a new NSPreferenceDescriptionLine.

NSPreferenceDescriptionLine CreateDefaultPreferenceDescriptionLine()

Returns: CRMScript.NetServer.NSPreferenceDescriptionLine

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

Example:

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

DeleteFromSectionAndKey(String,String)

Gets an NSPreferenceDescription based on the section and key

Void DeleteFromSectionAndKey(String section, String key)

Returns: CRMScript.Global.Void Example:

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

DeletePrefDescLinesByPrefDescId(Integer)

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

Void DeletePrefDescLinesByPrefDescId(Integer prefDescId)

Returns: CRMScript.Global.Void Example:

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

DeletePrefDescLinesByPrefDescIds(Integer[])

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

Void DeletePrefDescLinesByPrefDescIds(Integer[] prefDescIds)

Returns: CRMScript.Global.Void Example:

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

DeletePreference(Integer)

Deletes a preference by ID

Void DeletePreference(Integer id)

Returns: CRMScript.Global.Void Example:

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

DeletePreferenceDescription(Integer)

Deletes the NSPreferenceDescription

DeletePreferenceDescription(Integer preferenceDescription)

Returns: CRMScript.Global.Void Example:

NSPreferenceAgent agent;
agent.DeletePreferenceDescription(123);

DeletePreferenceDescriptionLine(Integer)

Deletes the NSPreferenceDescriptionLine

DeletePreferenceDescriptionLine(Integer preferenceDescriptionLine)

Returns: CRMScript.Global.Void Example:

NSPreferenceAgent agent;
agent.DeletePreferenceDescriptionLine(123);

DeletePreferenceDescriptionLines(Integer[])

Deletes the PrefDescLines in the SuperOffice database

Void DeletePreferenceDescriptionLines(Integer[] prefDescLineIds)

Returns: CRMScript.Global.Void Example:

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

DeletePreferences(Integer[])

Deletes some preferences by ID

Void DeletePreferences(Integer[] ids)

Returns: CRMScript.Global.Void Example:

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

GetAll()

Gets a list of all PreferenceDescriptions in the system.

NSPreferenceDescription[] GetAll()

Returns: CRMScript.NetServer.NSPreferenceDescription[] Example:

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

GetAllFromSection(String)

Gets all NSPreferenceDescription-items in the specified section

NSPreferenceDescription[] GetAllFromSection(String section)

Returns: CRMScript.NetServer.NSPreferenceDescription[] Example:

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

GetFromSectionAndKey(String,String)

Gets an NSPreferenceDescription based on the section and key

NSPreferenceDescription GetFromSectionAndKey(String section, String key)

Returns: CRMScript.NetServer.NSPreferenceDescription Example:

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’

String GetNetServicesStatusUrl()

Returns: CRMScript.Global.String - URL; NULL if status does not need to be checked yet. Example:

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

GetPreference(Integer)

Gets a preference by ID

NSPreference GetPreference(Integer id)

Returns: CRMScript.NetServer.NSPreference Example:

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

GetPreferenceByName(String,String,Integer)

Gets a preference by name

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

Returns: CRMScript.NetServer.NSPreference Example:

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.

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

Returns: CRMScript.NetServer.NSPreference Example:

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

GetPreferenceDescription(Integer)

Gets an NSPreferenceDescription object.

NSPreferenceDescription GetPreferenceDescription(Integer preferenceDescriptionId)

Returns: CRMScript.NetServer.NSPreferenceDescription Example:

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

GetPreferenceDescriptionLine(Integer)

Gets an NSPreferenceDescriptionLine object.

NSPreferenceDescriptionLine GetPreferenceDescriptionLine(Integer preferenceDescriptionLineId)

Returns: CRMScript.NetServer.NSPreferenceDescriptionLine Example:

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

GetPreferenceDescriptionLineFromIdAndValue(Integer,String)

Gets a preference description line from a prefDesc_id and a prefValue

NSPreferenceDescriptionLine GetPreferenceDescriptionLineFromIdAndValue(Integer prefDescId, String prefValue)

Returns: CRMScript.NetServer.NSPreferenceDescriptionLine Example:

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

GetPreferenceDescriptionLinesByPrefDescId(Integer)

Gets all preference description lines from a prefDesc_id

NSPreferenceDescriptionLine[] GetPreferenceDescriptionLinesByPrefDescId(Integer prefDescId)

Returns: CRMScript.NetServer.NSPreferenceDescriptionLine[] Example:

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

GetPreferences(NSPreferenceSpec[])

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

NSPreference[] GetPreferences(NSPreferenceSpec[] specifications)

Returns: CRMScript.NetServer.NSPreference[]

The prefDisplayvalue and prefDisplaytooltip are blank (faster processing relative to GetPreferencesWithDisplayValues)

Example:

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

GetPreferencesWithDisplayValues(NSPreferenceSpec[])

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

NSPreference[] GetPreferencesWithDisplayValues(NSPreferenceSpec[] specifications)

Returns: CRMScript.NetServer.NSPreference[]

The PrefDisplayValue and PrefDisplaytooltip are populated, at some additional processing cost.

Example:

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

GetTabOrder(String)

Gets the tab order.

NSTabOrder GetTabOrder(String tabName)

Returns: CRMScript.NetServer.NSTabOrder Example:

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

GetTabOrders()

NSTabOrder[] GetTabOrders()

Returns: CRMScript.NetServer.NSTabOrder[]

SaveFromSectionAndKey(String,String,NSPreferenceDescription)

Updates an NSPreferenceDescription based on the section and key

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

Returns: CRMScript.NetServer.NSPreferenceDescription Example:

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

SavePreference(NSPreference)

Saves this preference

Void SavePreference(NSPreference preference)

Returns: CRMScript.Global.Void Example:

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

SavePreferenceDescription(NSPreferenceDescription)

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

NSPreferenceDescription SavePreferenceDescription(NSPreferenceDescription preferenceDescription)

Returns: CRMScript.NetServer.NSPreferenceDescription Example:

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

NSPreferenceDescriptionLine SavePreferenceDescriptionLine(NSPreferenceDescriptionLine preferenceDescriptionLine)

Returns: CRMScript.NetServer.NSPreferenceDescriptionLine Example:

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

SavePreferenceDescriptionLines(NSPreferenceDescriptionLine[])

Saves the PreferenceDescriptionLine array in the SuperOffice database

NSPreferenceDescriptionLine[] SavePreferenceDescriptionLines(NSPreferenceDescriptionLine[] preferenceDescriptionLines)

Returns: CRMScript.NetServer.NSPreferenceDescriptionLine[] Example:

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

SavePreferenceEntities(NSPreference[],Bool)

Saves this set of preferences.

Void SavePreferenceEntities(NSPreference[] preferences, Bool removeLowerLevels)

Returns: CRMScript.Global.Void

SavePreferenceEntity(NSPreference,Bool)

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

NSPreference SavePreferenceEntity(NSPreference preference, Bool removeLowerLevels)

Returns: CRMScript.NetServer.NSPreference

Preference administrator rights are required to use this

Example:

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

SavePreferences(NSPreference[])

Saves this set of preferences.

Void SavePreferences(NSPreference[] preferences)

Returns: CRMScript.Global.Void

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.

Void SaveTabOrder(NSTabOrder tabOrder)

Returns: CRMScript.Global.Void Example:

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

SaveTabOrders(NSTabOrder[])

Void SaveTabOrders(NSTabOrder[] tabOrders)

Returns: CRMScript.Global.Void

UpdateNetServicesStatus(String)

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

Void UpdateNetServicesStatus(String xmlOrJson)

Returns: CRMScript.Global.Void Example:

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

​Constructors

​NSPreferenceAgent()

​Methods

​CreateDefaultPreference()

​CreateDefaultPreferenceDescription()

​CreateDefaultPreferenceDescriptionLine()

​DeleteFromSectionAndKey(String,String)

​DeletePrefDescLinesByPrefDescId(Integer)

​DeletePrefDescLinesByPrefDescIds(Integer[])

​DeletePreference(Integer)

​DeletePreferenceDescription(Integer)

​DeletePreferenceDescriptionLine(Integer)

​DeletePreferenceDescriptionLines(Integer[])

​DeletePreferences(Integer[])

​GetAll()

​GetAllFromSection(String)

​GetFromSectionAndKey(String,String)

​GetNetServicesStatusUrl()

​GetPreference(Integer)

​GetPreferenceByName(String,String,Integer)

​GetPreferenceByNameAndId(String,String,Integer,Integer)

​GetPreferenceDescription(Integer)

​GetPreferenceDescriptionLine(Integer)

​GetPreferenceDescriptionLineFromIdAndValue(Integer,String)

​GetPreferenceDescriptionLinesByPrefDescId(Integer)

​GetPreferences(NSPreferenceSpec[])

​GetPreferencesWithDisplayValues(NSPreferenceSpec[])

​GetTabOrder(String)

​GetTabOrders()

​SaveFromSectionAndKey(String,String,NSPreferenceDescription)

​SavePreference(NSPreference)

​SavePreferenceDescription(NSPreferenceDescription)

​SavePreferenceDescriptionLine(NSPreferenceDescriptionLine)

​SavePreferenceDescriptionLines(NSPreferenceDescriptionLine[])

​SavePreferenceEntities(NSPreference[],Bool)

​SavePreferenceEntity(NSPreference,Bool)

​SavePreferences(NSPreference[])

​SaveTabOrder(NSTabOrder)

​SaveTabOrders(NSTabOrder[])

​UpdateNetServicesStatus(String)

Constructors

NSPreferenceAgent()

Methods

CreateDefaultPreference()

CreateDefaultPreferenceDescription()

CreateDefaultPreferenceDescriptionLine()

DeleteFromSectionAndKey(String,String)

DeletePrefDescLinesByPrefDescId(Integer)

DeletePrefDescLinesByPrefDescIds(Integer[])

DeletePreference(Integer)

DeletePreferenceDescription(Integer)

DeletePreferenceDescriptionLine(Integer)

DeletePreferenceDescriptionLines(Integer[])

DeletePreferences(Integer[])

GetAll()

GetAllFromSection(String)

GetFromSectionAndKey(String,String)

GetNetServicesStatusUrl()

GetPreference(Integer)

GetPreferenceByName(String,String,Integer)

GetPreferenceByNameAndId(String,String,Integer,Integer)

GetPreferenceDescription(Integer)

GetPreferenceDescriptionLine(Integer)

GetPreferenceDescriptionLineFromIdAndValue(Integer,String)

GetPreferenceDescriptionLinesByPrefDescId(Integer)

GetPreferences(NSPreferenceSpec[])

GetPreferencesWithDisplayValues(NSPreferenceSpec[])

GetTabOrder(String)

GetTabOrders()

SaveFromSectionAndKey(String,String,NSPreferenceDescription)

SavePreference(NSPreference)

SavePreferenceDescription(NSPreferenceDescription)

SavePreferenceDescriptionLine(NSPreferenceDescriptionLine)

SavePreferenceDescriptionLines(NSPreferenceDescriptionLine[])

SavePreferenceEntities(NSPreference[],Bool)

SavePreferenceEntity(NSPreference,Bool)

SavePreferences(NSPreference[])

SaveTabOrder(NSTabOrder)

SaveTabOrders(NSTabOrder[])

UpdateNetServicesStatus(String)