Class PreferenceAgent

Proxy class for the Preference Agent Used when communicating remote using WebServices. Avoid using directly. Use the AgentFactory to create the proxy instead.

Inheritance

object

PreferenceAgent

Implements

IPreferenceAgent

IAgent

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: SuperOffice.CRM.Services

Assembly: SuperOffice.Services.Implementation.dll

Syntax

public class PreferenceAgent : IPreferenceAgent, IAgent

Constructors

PreferenceAgent(IPreferenceImplementation, IPreferenceDescriptionImplementation, IPreferenceDescriptionLineImplementation, IPreferenceListImplementation, ISoRequestItemsAccessor)

Proxy class for the Preference Agent Used when communicating remote using WebServices. Avoid using directly. Use the AgentFactory to create the proxy instead.

Declaration

public PreferenceAgent(IPreferenceImplementation preferenceImplementation, IPreferenceDescriptionImplementation preferenceDescriptionImplementation, IPreferenceDescriptionLineImplementation preferenceDescriptionLineImplementation, IPreferenceListImplementation preferenceListImplementation, ISoRequestItemsAccessor accessor)

Parameters

Type	Name	Description
IPreferenceImplementation	preferenceImplementation
IPreferenceDescriptionImplementation	preferenceDescriptionImplementation
IPreferenceDescriptionLineImplementation	preferenceDescriptionLineImplementation
IPreferenceListImplementation	preferenceListImplementation
ISoRequestItemsAccessor	accessor

PreferenceAgent(IPreferenceImplementation, IPreferenceDescriptionImplementation, IPreferenceDescriptionLineImplementation, IPreferenceListImplementation, ISoRequestItemsAccessor, IDebugUser, IServiceCallsRepository, IScriptingConfiguration, IOnlineConfiguration)

Proxy class for the Preference Agent Used when communicating remote using WebServices. Avoid using directly. Use the AgentFactory to create the proxy instead.

Declaration

public PreferenceAgent(IPreferenceImplementation preferenceImplementation, IPreferenceDescriptionImplementation preferenceDescriptionImplementation, IPreferenceDescriptionLineImplementation preferenceDescriptionLineImplementation, IPreferenceListImplementation preferenceListImplementation, ISoRequestItemsAccessor accessor, IDebugUser debugUser, IServiceCallsRepository serviceCallsRepository, ConfigFile.IScriptingConfiguration scriptingConfiguration, ConfigFile.IOnlineConfiguration onlineConfiguration)

Parameters

Type	Name	Description
IPreferenceImplementation	preferenceImplementation
IPreferenceDescriptionImplementation	preferenceDescriptionImplementation
IPreferenceDescriptionLineImplementation	preferenceDescriptionLineImplementation
IPreferenceListImplementation	preferenceListImplementation
ISoRequestItemsAccessor	accessor
IDebugUser	debugUser
IServiceCallsRepository	serviceCallsRepository
IScriptingConfiguration	scriptingConfiguration
IOnlineConfiguration	onlineConfiguration

Methods

CreateDefaultPreferenceAsync(CancellationToken)

Loading default values into a new Preference.

Declaration

public Task<Preference> CreateDefaultPreferenceAsync(CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CancellationToken	cancellationToken	This operation cannot be cancelled; the cancellationToken parameter is ignored

Returns

Type	Description
Task<Preference>	New Preference with default values

CreateDefaultPreferenceDescriptionAsync(CancellationToken)

Loading default values into a new PreferenceDescription.

Declaration

public Task<PreferenceDescription> CreateDefaultPreferenceDescriptionAsync(CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CancellationToken	cancellationToken	This operation cannot be cancelled; the cancellationToken parameter is ignored

Returns

Type	Description
Task<PreferenceDescription>	New PreferenceDescription with default values

CreateDefaultPreferenceDescriptionLineAsync(CancellationToken)

Loading default values into a new PreferenceDescriptionLine.

Declaration

public Task<PreferenceDescriptionLine> CreateDefaultPreferenceDescriptionLineAsync(CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CancellationToken	cancellationToken	This operation cannot be cancelled; the cancellationToken parameter is ignored

Returns

Type	Description
Task<PreferenceDescriptionLine>	New PreferenceDescriptionLine with default values

DeleteFromSectionAndKeyAsync(string, string, CancellationToken)

Gets a PreferenceDescription based on the section and key

Declaration

public Task DeleteFromSectionAndKeyAsync(string section, string key, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	section	The PreferenceDescription-section
string	key	The PreferenceDescription-key
CancellationToken	cancellationToken	This operation cannot be cancelled; the cancellationToken parameter is ignored

Returns

Type	Description
Task	This method has no return value

DeletePrefDescLinesByPrefDescIdAsync(int, CancellationToken)

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

Declaration

public Task DeletePrefDescLinesByPrefDescIdAsync(int prefDescId, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int	prefDescId	Primary key of the Preference Description that contains PrefDescLines to delete
CancellationToken	cancellationToken	This operation cannot be cancelled; the cancellationToken parameter is ignored

Returns

Type	Description
Task	Nothing

DeletePrefDescLinesByPrefDescIdsAsync(int[], CancellationToken)

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

Declaration

public Task DeletePrefDescLinesByPrefDescIdsAsync(int[] prefDescIds, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int[]	prefDescIds	Primary keys of the Preference Descriptions that contains PrefDescLines to delete
CancellationToken	cancellationToken	This operation cannot be cancelled; the cancellationToken parameter is ignored

Returns

Type	Description
Task	Nothing

DeletePreferenceAsync(int, CancellationToken)

Delete a preference by id

Declaration

public Task DeletePreferenceAsync(int id, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int	id	The id of the preference to delete
CancellationToken	cancellationToken	This operation cannot be cancelled; the cancellationToken parameter is ignored

Returns

Type	Description
Task	This method has no return value

DeletePreferenceDescriptionAsync(int, CancellationToken)

Deletes the PreferenceDescription

Declaration

public Task DeletePreferenceDescriptionAsync(int preferenceDescriptionId, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int	preferenceDescriptionId	The identity of the PreferenceDescription
CancellationToken	cancellationToken	This operation cannot be cancelled; the cancellationToken parameter is ignored

Returns

Type	Description
Task	This method has no return value

DeletePreferenceDescriptionLineAsync(int, CancellationToken)

Deletes the PreferenceDescriptionLine

Declaration

public Task DeletePreferenceDescriptionLineAsync(int preferenceDescriptionLineId, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int	preferenceDescriptionLineId	The identity of the PreferenceDescriptionLine
CancellationToken	cancellationToken	This operation cannot be cancelled; the cancellationToken parameter is ignored

Returns

Type	Description
Task	This method has no return value

DeletePreferenceDescriptionLinesAsync(int[], CancellationToken)

Delete the PrefDescLines in the SuperOffice database

Declaration

public Task DeletePreferenceDescriptionLinesAsync(int[] prefDescLineIds, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int[]	prefDescLineIds	Primary keys of the PrefDescLines to delete
CancellationToken	cancellationToken	This operation cannot be cancelled; the cancellationToken parameter is ignored

Returns

Type	Description
Task	Nothing

DeletePreferencesAsync(int[], CancellationToken)

Delete some preferences by id

Declaration

public Task DeletePreferencesAsync(int[] ids, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int[]	ids	The ids of the preference to delete
CancellationToken	cancellationToken	This operation cannot be cancelled; the cancellationToken parameter is ignored

Returns

Type	Description
Task	This method has no return value

GetAllAsync(CancellationToken)

Gets a list of all PreferenceDescriptions in the system.

Declaration

public Task<PreferenceDescription[]> GetAllAsync(CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CancellationToken	cancellationToken	This operation cannot be cancelled; the cancellationToken parameter is ignored

Returns

Type	Description
Task<PreferenceDescription[]>	All PreferenceDescriptions in the system

GetAllFromSectionAsync(string, CancellationToken)

Gets all PreferenceDescription-items in the specified section

Declaration

public Task<PreferenceDescription[]> GetAllFromSectionAsync(string section, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	section	The PreferenceDescription-section
CancellationToken	cancellationToken	This operation cannot be cancelled; the cancellationToken parameter is ignored

Returns

Type	Description
Task<PreferenceDescription[]>	All PreferenceDescriptions found.

GetFromSectionAndKeyAsync(string, string, CancellationToken)

Gets a PreferenceDescription based on the section and key

Declaration

public Task<PreferenceDescription> GetFromSectionAndKeyAsync(string section, string key, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	section	The PreferenceDescription-section
string	key	The PreferenceDescription-key
CancellationToken	cancellationToken	This operation cannot be cancelled; the cancellationToken parameter is ignored

Returns

Type	Description
Task<PreferenceDescription>	A PreferenceDescription or null

GetNetServicesStatusUrlAsync(CancellationToken)

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 Task<string> GetNetServicesStatusUrlAsync(CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CancellationToken	cancellationToken	This operation cannot be cancelled; the cancellationToken parameter is ignored

Returns

Type	Description
Task<string>	NULL or URL of the status service that returns an XML or JSON block.

GetPreferenceAsync(int, CancellationToken)

Get a preference by id

Declaration

public Task<Preference> GetPreferenceAsync(int id, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int	id	The id of the preference to load
CancellationToken	cancellationToken	This operation cannot be cancelled; the cancellationToken parameter is ignored

Returns

Type	Description
Task<Preference>	The preference loaded

GetPreferenceByNameAndIdAsync(string, string, PreferenceLevel, int, CancellationToken)

Get a preference by name and owner id.

Declaration

public Task<Preference> GetPreferenceByNameAndIdAsync(string prefSection, string prefKey, PreferenceLevel prefLevel, int ownerId, CancellationToken cancellationToken = default)

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.
int	ownerId	The preference owner id, individual or group.
CancellationToken	cancellationToken	This operation cannot be cancelled; the cancellationToken parameter is ignored

Returns

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

GetPreferenceByNameAsync(string, string, PreferenceLevel, CancellationToken)

Get a preference by name

Declaration

public Task<Preference> GetPreferenceByNameAsync(string prefSection, string prefKey, PreferenceLevel prefLevel, CancellationToken cancellationToken = default)

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.
CancellationToken	cancellationToken	This operation cannot be cancelled; the cancellationToken parameter is ignored

Returns

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

GetPreferenceDescriptionAsync(int, CancellationToken)

Gets a PreferenceDescription object.

Declaration

public Task<PreferenceDescription> GetPreferenceDescriptionAsync(int preferenceDescriptionId, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int	preferenceDescriptionId	The identifier of the PreferenceDescription object
CancellationToken	cancellationToken	This operation cannot be cancelled; the cancellationToken parameter is ignored

Returns

Type	Description
Task<PreferenceDescription>	A single PreferenceDescription

GetPreferenceDescriptionLineAsync(int, CancellationToken)

Gets a PreferenceDescriptionLine object.

Declaration

public Task<PreferenceDescriptionLine> GetPreferenceDescriptionLineAsync(int preferenceDescriptionLineId, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int	preferenceDescriptionLineId	The identifier of the PreferenceDescriptionLine object
CancellationToken	cancellationToken	This operation cannot be cancelled; the cancellationToken parameter is ignored

Returns

Type	Description
Task<PreferenceDescriptionLine>	A single PreferenceDescriptionLine

GetPreferenceDescriptionLineFromIdAndValueAsync(int, string, CancellationToken)

Get a preference description line from a prefDesc_id and a prefValue

Declaration

public Task<PreferenceDescriptionLine> GetPreferenceDescriptionLineFromIdAndValueAsync(int prefDescId, string prefValue, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int	prefDescId	The id of the preference description this line is connected to
string	prefValue	The value of the description line to return
CancellationToken	cancellationToken	This operation cannot be cancelled; the cancellationToken parameter is ignored

Returns

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

GetPreferenceDescriptionLinesByPrefDescIdAsync(int, CancellationToken)

Get all preference description lines from a prefDesc_id

Declaration

public Task<PreferenceDescriptionLine[]> GetPreferenceDescriptionLinesByPrefDescIdAsync(int prefDescId, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int	prefDescId	The id of the preference description this line is connected to
CancellationToken	cancellationToken	This operation cannot be cancelled; the cancellationToken parameter is ignored

Returns

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

GetPreferencesAsync(PreferenceSpec[], CancellationToken)

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 Task<Preference[]> GetPreferencesAsync(PreferenceSpec[] specifications, CancellationToken cancellationToken = default)

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!
CancellationToken	cancellationToken	This operation cannot be cancelled; the cancellationToken parameter is ignored

Returns

Type	Description
Task<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.

GetPreferencesWithDisplayValuesAsync(PreferenceSpec[], CancellationToken)

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 Task<Preference[]> GetPreferencesWithDisplayValuesAsync(PreferenceSpec[] specifications, CancellationToken cancellationToken = default)

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!
CancellationToken	cancellationToken	This operation cannot be cancelled; the cancellationToken parameter is ignored

Returns

Type	Description
Task<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.

GetTabOrderAsync(string, CancellationToken)

Gets the tab order.

Declaration

public Task<TabOrder> GetTabOrderAsync(string tabName, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	tabName	Name of the tab control
CancellationToken	cancellationToken	This operation cannot be cancelled; the cancellationToken parameter is ignored

Returns

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

GetTabOrdersAsync(CancellationToken)

Proxy class for the Preference Agent Used when communicating remote using WebServices. Avoid using directly. Use the AgentFactory to create the proxy instead.

Declaration

public Task<TabOrder[]> GetTabOrdersAsync(CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CancellationToken	cancellationToken	This operation cannot be cancelled; the cancellationToken parameter is ignored

Returns

Type	Description
Task<TabOrder[]>

GetXsrfPathsAsync(string, CancellationToken)

Returns paths that XSRF cookies should be set on

Declaration

public Task<string[]> GetXsrfPathsAsync(string hostname, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	hostname	The hostname that we are storing paths for.
CancellationToken	cancellationToken	This operation cannot be cancelled; the cancellationToken parameter is ignored

Returns

Type	Description
Task<string[]>	Paths that XSRF cookies should be set for: ['/cs', '/crm']

SaveFromSectionAndKeyAsync(string, string, PreferenceDescription, CancellationToken)

Update a PreferenceDescription based on the section and key

Declaration

public Task<PreferenceDescription> SaveFromSectionAndKeyAsync(string section, string key, PreferenceDescription preferenceDescription, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	section	The PreferenceDescription-section
string	key	The PreferenceDescription-key
PreferenceDescription	preferenceDescription	The PreferenceDescription to save.
CancellationToken	cancellationToken	This operation cannot be cancelled; the cancellationToken parameter is ignored

Returns

Type	Description
Task<PreferenceDescription>	Saved PreferenceDescription

SavePreferenceAsync(Preference, CancellationToken)

Save this preference

Declaration

public Task SavePreferenceAsync(Preference preference, CancellationToken cancellationToken = default)

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.
CancellationToken	cancellationToken	This operation cannot be cancelled; the cancellationToken parameter is ignored

Returns

Type	Description
Task	This method has no return value

SavePreferenceDescriptionAsync(PreferenceDescription, CancellationToken)

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

Declaration

public Task<PreferenceDescription> SavePreferenceDescriptionAsync(PreferenceDescription preferenceDescription, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
PreferenceDescription	preferenceDescription	The PreferenceDescription that is saved
CancellationToken	cancellationToken	This operation cannot be cancelled; the cancellationToken parameter is ignored

Returns

Type	Description
Task<PreferenceDescription>	New or updated PreferenceDescription

SavePreferenceDescriptionLineAsync(PreferenceDescriptionLine, CancellationToken)

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

Declaration

public Task<PreferenceDescriptionLine> SavePreferenceDescriptionLineAsync(PreferenceDescriptionLine preferenceDescriptionLine, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
PreferenceDescriptionLine	preferenceDescriptionLine	The PreferenceDescriptionLine that is saved
CancellationToken	cancellationToken	This operation cannot be cancelled; the cancellationToken parameter is ignored

Returns

Type	Description
Task<PreferenceDescriptionLine>	New or updated PreferenceDescriptionLine

SavePreferenceDescriptionLinesAsync(PreferenceDescriptionLine[], CancellationToken)

Saves the PreferenceDescriptionLine array in the SuperOffice database

Declaration

public Task<PreferenceDescriptionLine[]> SavePreferenceDescriptionLinesAsync(PreferenceDescriptionLine[] preferenceDescriptionLines, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
PreferenceDescriptionLine[]	preferenceDescriptionLines	The PreferenceDescriptionLine array to save.
CancellationToken	cancellationToken	This operation cannot be cancelled; the cancellationToken parameter is ignored

Returns

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

SavePreferenceEntitiesAsync(Preference[], bool, CancellationToken)

Save this set of preferences.

Declaration

public Task SavePreferenceEntitiesAsync(Preference[] preferences, bool removeLowerLevels, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Preference[]	preferences	Preferences to be saved. Note that all fields must be filled in.
bool	removeLowerLevels	If this is true, all user preferences on lower levels will be deleted
CancellationToken	cancellationToken	This operation cannot be cancelled; the cancellationToken parameter is ignored

Returns

Type	Description
Task

SavePreferenceEntityAsync(Preference, bool, CancellationToken)

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

Declaration

public Task<Preference> SavePreferenceEntityAsync(Preference preference, bool removeLowerLevels, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Preference	preference	The preference object to be saved
bool	removeLowerLevels	If this is true, all user preferences on lower levels will be deleted
CancellationToken	cancellationToken	This operation cannot be cancelled; the cancellationToken parameter is ignored

Returns

Type	Description
Task<Preference>	Returns the saved preference

SavePreferencesAsync(Preference[], CancellationToken)

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 Task SavePreferencesAsync(Preference[] preferences, CancellationToken cancellationToken = default)

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.
CancellationToken	cancellationToken	This operation cannot be cancelled; the cancellationToken parameter is ignored

Returns

Type	Description
Task

SaveTabOrderAsync(TabOrder, CancellationToken)

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

Declaration

public Task SaveTabOrderAsync(TabOrder tabOrder, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
TabOrder	tabOrder	Name of the tab control
CancellationToken	cancellationToken	This operation cannot be cancelled; the cancellationToken parameter is ignored

Returns

Type	Description
Task	This method has no return value

SaveTabOrdersAsync(TabOrder[], CancellationToken)

Proxy class for the Preference Agent Used when communicating remote using WebServices. Avoid using directly. Use the AgentFactory to create the proxy instead.

Declaration

public Task SaveTabOrdersAsync(TabOrder[] tabOrders, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
TabOrder[]	tabOrders
CancellationToken	cancellationToken	This operation cannot be cancelled; the cancellationToken parameter is ignored

Returns

Type	Description
Task

SetXsrfPathsAsync(string, string[], CancellationToken)

Update the paths that need XSRF cookies

Declaration

public Task SetXsrfPathsAsync(string hostname, string[] paths, CancellationToken cancellationToken = default)

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']
CancellationToken	cancellationToken	This operation cannot be cancelled; the cancellationToken parameter is ignored

Returns

Type	Description
Task	This method has no return value

UpdateNetServicesStatusAsync(string, CancellationToken)

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

Declaration

public Task UpdateNetServicesStatusAsync(string xmlOrJson, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	xmlOrJson
CancellationToken	cancellationToken	This operation cannot be cancelled; the cancellationToken parameter is ignored

Returns

Type	Description
Task	This method has no return value

Implements

IPreferenceAgent

IAgent