Skip to main content

<a id=“SuperOffice_WebApi_Agents_PreferenceAgent”></a> Class PreferenceAgent

Namespace: SuperOffice.WebApi.Agents
Assembly: SuperOffice.WebApi.dll
Preferences, user interface tab configuration

Inheritance

objectAgentBasePreferenceAgent

Implements

IPreferenceAgent, IAgentBase, IDisposable

Inherited Members

AgentBase._json, AgentBase._binary, AgentBase._config, AgentBase._client, AgentBase._disposeClient, AgentBase.Merge(RequestOptions), AgentBase.BuildRequestFromObject(HttpMethod, string, object, WebApiOptions, string), AgentBase.BuildRequestFromStream(HttpMethod, string, Stream, WebApiOptions, string), AgentBase.BuildRequestFromObjectWithStream(HttpMethod, string, object, Stream, WebApiOptions, string), AgentBase.ParseAuthorization(IAuthorization), AgentBase.CancelRequest(), AgentBase.SendRequestObject(HttpMethod, string, object, WebApiOptions, string), AgentBase.SendRequestObjectWithStream(HttpMethod, string, object, Stream, WebApiOptions, string), AgentBase.SendRequest(HttpRequestMessage, RequestOptions), AgentBase.ThrowOnResponseErrorAsync(HttpRequestMessage, HttpResponseMessage), AgentBase.ParseResponse<T&gt;(HttpResponseMessage), AgentBase.Finally(RequestOptions), AgentBase.Dispose(), AgentBase.Configuration, AgentBase.Client, AgentBase.HasRunningRequest, AgentBase.ClientCancellationTokenSource, AgentBase.ProgressListener, AgentBase.UploadProgressListener, object.ToString(), object.Equals(object), object.Equals(object, object), object.ReferenceEquals(object, object), object.GetHashCode(), object.GetType(), object.MemberwiseClone()

Examples

<pre><code class=“lang-csharp”>using SuperOffice.WebApi; using SuperOffice.WebApi.Agents; var mySession = new WebApiOptions(“http://example.com/super/api”); mySession.Authorization = new AuthorizationUsernamePassword(“user”, “pass”); using (PreferenceAgent agent = new PreferenceAgent(mySession)) { // call methods on agent here… }</code></pre>

Constructors

<a id=“SuperOffice_WebApi_Agents_PreferenceAgent__ctor_System_Net_Http_HttpClient_”></a> PreferenceAgent(HttpClient)

Constructor: Preferences, user interface tab configuration

Parameters

httpClient HttpClient Use this HTTP client instead of making own HttpClient instance.

<a id=“SuperOffice_WebApi_Agents_PreferenceAgent__ctor_SuperOffice_WebApi_WebApiOptions_System_Net_Http_HttpClient_”></a> PreferenceAgent(WebApiOptions, HttpClient)

Constructor: Preferences, user interface tab configuration

Parameters

options WebApiOptions Base URL and authentication values. httpClient HttpClient Optional: Use this HTTP client instead of making a new one.

Methods

<a id=“SuperOffice_WebApi_Agents_PreferenceAgent_CreateDefaultPreferenceAsync_SuperOffice_WebApi_RequestOptions_”></a> CreateDefaultPreferenceAsync(RequestOptions)

Set default values into a new Preference. NetServer calculates default values on the entity, which is required when creating/storing a new instance

Parameters

requestOptions RequestOptions Override language/culture codes on this request.

Returns

Task<Preference&gt; A blank Preference

<a id=“SuperOffice_WebApi_Agents_PreferenceAgent_CreateDefaultPreferenceDescriptionAsync_SuperOffice_WebApi_RequestOptions_”></a> CreateDefaultPreferenceDescriptionAsync(RequestOptions)

Set default values into a new PreferenceDescription. NetServer calculates default values on the entity, which is required when creating/storing a new instance

Parameters

requestOptions RequestOptions Override language/culture codes on this request.

Returns

Task<PreferenceDescription&gt; A blank PreferenceDescription

<a id=“SuperOffice_WebApi_Agents_PreferenceAgent_CreateDefaultPreferenceDescriptionLineAsync_SuperOffice_WebApi_RequestOptions_”></a> CreateDefaultPreferenceDescriptionLineAsync(RequestOptions)

Set default values into a new PreferenceDescriptionLine. NetServer calculates default values on the entity, which is required when creating/storing a new instance

Parameters

requestOptions RequestOptions Override language/culture codes on this request.

Returns

Task<PreferenceDescriptionLine&gt; A blank PreferenceDescriptionLine

<a id=“SuperOffice_WebApi_Agents_PreferenceAgent_DeleteFromSectionAndKeyAsync_System_String_System_String_SuperOffice_WebApi_RequestOptions_”></a> DeleteFromSectionAndKeyAsync(string, string, RequestOptions)

Gets a PreferenceDescription based on the section and key

Parameters

section string The PreferenceDescription-section key string The PreferenceDescription-key requestOptions RequestOptions Override language/culture codes on this request.

Returns

Task This method has no return value

<a id=“SuperOffice_WebApi_Agents_PreferenceAgent_DeletePrefDescLinesByPrefDescIdAsync_System_Int32_SuperOffice_WebApi_RequestOptions_”></a> DeletePrefDescLinesByPrefDescIdAsync(int, RequestOptions)

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

Parameters

prefDescId int Primary key of the Preference Description that contains PrefDescLines to delete requestOptions RequestOptions Override language/culture codes on this request.

Returns

Task Nothing

<a id=“SuperOffice_WebApi_Agents_PreferenceAgent_DeletePrefDescLinesByPrefDescIdsAsync_System_Int32___SuperOffice_WebApi_RequestOptions_”></a> DeletePrefDescLinesByPrefDescIdsAsync(int[], RequestOptions)

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

Parameters

prefDescIds int[] Primary keys of the Preference Descriptions that contains PrefDescLines to delete requestOptions RequestOptions Override language/culture codes on this request.

Returns

Task Nothing

<a id=“SuperOffice_WebApi_Agents_PreferenceAgent_DeletePreferenceAsync_System_Int32_SuperOffice_WebApi_RequestOptions_”></a> DeletePreferenceAsync(int, RequestOptions)

Delete a preference by id

Parameters

id int The id of the preference to delete requestOptions RequestOptions Override language/culture codes on this request.

Returns

Task This method has no return value

<a id=“SuperOffice_WebApi_Agents_PreferenceAgent_DeletePreferenceDescriptionAsync_System_Int32_SuperOffice_WebApi_RequestOptions_”></a> DeletePreferenceDescriptionAsync(int, RequestOptions)

Deletes the PreferenceDescription

Parameters

preferenceDescriptionId int The identity of the PreferenceDescription requestOptions RequestOptions Override language/culture codes on this request.

Returns

Task

<a id=“SuperOffice_WebApi_Agents_PreferenceAgent_DeletePreferenceDescriptionLineAsync_System_Int32_SuperOffice_WebApi_RequestOptions_”></a> DeletePreferenceDescriptionLineAsync(int, RequestOptions)

Deletes the PreferenceDescriptionLine

Parameters

preferenceDescriptionLineId int The identity of the PreferenceDescriptionLine requestOptions RequestOptions Override language/culture codes on this request.

Returns

Task

<a id=“SuperOffice_WebApi_Agents_PreferenceAgent_DeletePreferenceDescriptionLinesAsync_System_Int32___SuperOffice_WebApi_RequestOptions_”></a> DeletePreferenceDescriptionLinesAsync(int[], RequestOptions)

Delete the PrefDescLines in the SuperOffice database

Parameters

prefDescLineIds int[] Primary keys of the PrefDescLines to delete requestOptions RequestOptions Override language/culture codes on this request.

Returns

Task Nothing

<a id=“SuperOffice_WebApi_Agents_PreferenceAgent_DeletePreferencesAsync_System_Int32___SuperOffice_WebApi_RequestOptions_”></a> DeletePreferencesAsync(int[], RequestOptions)

Delete some preferences by id

Parameters

ids int[] The ids of the preference to delete requestOptions RequestOptions Override language/culture codes on this request.

Returns

Task This method has no return value

<a id=“SuperOffice_WebApi_Agents_PreferenceAgent_GetAllAsync_SuperOffice_WebApi_RequestOptions_”></a> GetAllAsync(RequestOptions)

Gets a list of all PreferenceDescriptions in the system.

Parameters

requestOptions RequestOptions Override language/culture codes on this request.

Returns

Task<PreferenceDescription[]&gt; All PreferenceDescriptions in the system

<a id=“SuperOffice_WebApi_Agents_PreferenceAgent_GetAllFromSectionAsync_System_String_SuperOffice_WebApi_RequestOptions_”></a> GetAllFromSectionAsync(string, RequestOptions)

Gets all PreferenceDescription-items in the specified section

Parameters

section string The PreferenceDescription-section requestOptions RequestOptions Override language/culture codes on this request.

Returns

Task<PreferenceDescription[]&gt; All PreferenceDescriptions found.

<a id=“SuperOffice_WebApi_Agents_PreferenceAgent_GetFromSectionAndKeyAsync_System_String_System_String_SuperOffice_WebApi_RequestOptions_”></a> GetFromSectionAndKeyAsync(string, string, RequestOptions)

Gets a PreferenceDescription based on the section and key

Parameters

section string The PreferenceDescription-section key string The PreferenceDescription-key requestOptions RequestOptions Override language/culture codes on this request.

Returns

Task<PreferenceDescription&gt; A PreferenceDescription or null

<a id=“SuperOffice_WebApi_Agents_PreferenceAgent_GetNetServicesStatusUrlAsync_SuperOffice_WebApi_RequestOptions_”></a> GetNetServicesStatusUrlAsync(RequestOptions)

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.

Parameters

requestOptions RequestOptions Override language/culture codes on this request.

Returns

Task<string&gt; NULL or URL of the status service that returns an XML or JSON block.

<a id=“SuperOffice_WebApi_Agents_PreferenceAgent_GetPreferenceAsync_System_Int32_SuperOffice_WebApi_RequestOptions_”></a> GetPreferenceAsync(int, RequestOptions)

Get a preference by id

Parameters

id int The id of the preference to load requestOptions RequestOptions Override language/culture codes on this request.

Returns

Task<Preference&gt; The preference loaded

<a id=“SuperOffice_WebApi_Agents_PreferenceAgent_GetPreferenceByNameAndIdAsync_System_String_System_String_SuperOffice_WebApi_Data_PreferenceLevel_System_Int32_SuperOffice_WebApi_RequestOptions_”></a> GetPreferenceByNameAndIdAsync(string, string, PreferenceLevel, int, RequestOptions)

Get a preference by name and owner id.

Parameters

prefSection string The preference section name. e.g. ‘Functions’. See SuperOffice.CRM.UserPreferenceStrings for constants. prefKey string The preference key name. e.g. ‘ShowTipsAtStart’. See SuperOffice.CRM.UserPreferenceStrings for constants. prefLevel PreferenceLevel The preference level to read. Undefined (0) means to return the preference defined closest to the user. ownerId int The preference owner id, individual or group. requestOptions RequestOptions Override language/culture codes on this request.

Returns

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

<a id=“SuperOffice_WebApi_Agents_PreferenceAgent_GetPreferenceByNameAsync_System_String_System_String_SuperOffice_WebApi_Data_PreferenceLevel_SuperOffice_WebApi_RequestOptions_”></a> GetPreferenceByNameAsync(string, string, PreferenceLevel, RequestOptions)

Get a preference by name

Parameters

prefSection string The preference section name. e.g. ‘Functions’. See SuperOffice.CRM.UserPreferenceStrings for constants. prefKey string The preference key name. e.g. ‘ShowTipsAtStart’. See SuperOffice.CRM.UserPreferenceStrings for constants. prefLevel PreferenceLevel The preference level to read. Undefined (0) means to return the preference defined closest to the user. requestOptions RequestOptions Override language/culture codes on this request.

Returns

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

<a id=“SuperOffice_WebApi_Agents_PreferenceAgent_GetPreferenceDescriptionAsync_System_Int32_SuperOffice_WebApi_RequestOptions_”></a> GetPreferenceDescriptionAsync(int, RequestOptions)

Gets a specific PreferenceDescription object.

Parameters

preferenceDescriptionId int The identifier of the PreferenceDescription object requestOptions RequestOptions Override language/culture codes on this request.

Returns

Task<PreferenceDescription&gt; PreferenceDescription

<a id=“SuperOffice_WebApi_Agents_PreferenceAgent_GetPreferenceDescriptionLineAsync_System_Int32_SuperOffice_WebApi_RequestOptions_”></a> GetPreferenceDescriptionLineAsync(int, RequestOptions)

Gets a specific PreferenceDescriptionLine object.

Parameters

preferenceDescriptionLineId int The identifier of the PreferenceDescriptionLine object requestOptions RequestOptions Override language/culture codes on this request.

Returns

Task<PreferenceDescriptionLine&gt; PreferenceDescriptionLine

<a id=“SuperOffice_WebApi_Agents_PreferenceAgent_GetPreferenceDescriptionLineFromIdAndValueAsync_System_Int32_System_String_SuperOffice_WebApi_RequestOptions_”></a> GetPreferenceDescriptionLineFromIdAndValueAsync(int, string, RequestOptions)

Get a preference description line from a prefDesc_id and a prefValue

Parameters

prefDescId int The id of the preference description this line is connected to prefValue string The value of the description line to return requestOptions RequestOptions Override language/culture codes on this request.

Returns

Task<PreferenceDescriptionLine&gt; The preference description line matching the id and the value

<a id=“SuperOffice_WebApi_Agents_PreferenceAgent_GetPreferenceDescriptionLinesByPrefDescIdAsync_System_Int32_SuperOffice_WebApi_RequestOptions_”></a> GetPreferenceDescriptionLinesByPrefDescIdAsync(int, RequestOptions)

Get all preference description lines from a prefDesc_id

Parameters

prefDescId int The id of the preference description this line is connected to requestOptions RequestOptions Override language/culture codes on this request.

Returns

Task<PreferenceDescriptionLine[]&gt; The preference description lines matching the id

<a id=“SuperOffice_WebApi_Agents_PreferenceAgent_GetPreferencesAsync_SuperOffice_WebApi_Data_PreferenceSpec___SuperOffice_WebApi_RequestOptions_”></a> GetPreferencesAsync(PreferenceSpec[], RequestOptions)

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

Parameters

specifications PreferenceSpec[] 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! requestOptions RequestOptions Override language/culture codes on this request.

Returns

Task<Preference[]&gt; 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.

<a id=“SuperOffice_WebApi_Agents_PreferenceAgent_GetPreferencesWithDisplayValuesAsync_SuperOffice_WebApi_Data_PreferenceSpec___SuperOffice_WebApi_RequestOptions_”></a> GetPreferencesWithDisplayValuesAsync(PreferenceSpec[], RequestOptions)

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

Parameters

specifications PreferenceSpec[] 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! requestOptions RequestOptions Override language/culture codes on this request.

Returns

Task<Preference[]&gt; 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.

<a id=“SuperOffice_WebApi_Agents_PreferenceAgent_GetTabOrderAsync_System_String_SuperOffice_WebApi_RequestOptions_”></a> GetTabOrderAsync(string, RequestOptions)

Gets the tab order.

Parameters

tabName string Name of the tab control requestOptions RequestOptions Override language/culture codes on this request.

Returns

Task<TabOrder&gt; Tab order. Array of strings. Each string represent a named tab.

<a id=“SuperOffice_WebApi_Agents_PreferenceAgent_GetTabOrdersAsync_SuperOffice_WebApi_RequestOptions_”></a> GetTabOrdersAsync(RequestOptions)

Parameters

requestOptions RequestOptions Override language/culture codes on this request.

Returns

Task<TabOrder[]&gt;

<a id=“SuperOffice_WebApi_Agents_PreferenceAgent_GetXsrfPathsAsync_System_String_SuperOffice_WebApi_RequestOptions_”></a> GetXsrfPathsAsync(string, RequestOptions)

Returns paths that XSRF cookies should be set on

Parameters

hostname string The hostname that we are storing paths for. requestOptions RequestOptions Override language/culture codes on this request.

Returns

Task<string[]&gt; Paths that XSRF cookies should be set for: [‘/cs’, ‘/crm’]

<a id=“SuperOffice_WebApi_Agents_PreferenceAgent_GetXsrfValueAsync_SuperOffice_WebApi_RequestOptions_”></a> GetXsrfValueAsync(RequestOptions)

Returns the XSRF token value and last update time for the current user

Parameters

requestOptions RequestOptions Override language/culture codes on this request.

Returns

Task<XsrfValue&gt; The XSRF token value and timestamp

<a id=“SuperOffice_WebApi_Agents_PreferenceAgent_SaveFromSectionAndKeyAsync_System_String_System_String_SuperOffice_WebApi_Data_PreferenceDescription_SuperOffice_WebApi_RequestOptions_”></a> SaveFromSectionAndKeyAsync(string, string, PreferenceDescription, RequestOptions)

Update a PreferenceDescription based on the section and key

Parameters

section string The PreferenceDescription-section key string The PreferenceDescription-key preferenceDescription PreferenceDescription The PreferenceDescription to save. requestOptions RequestOptions Override language/culture codes on this request.

Returns

Task<PreferenceDescription&gt; Saved PreferenceDescription

<a id=“SuperOffice_WebApi_Agents_PreferenceAgent_SavePreferenceAsync_SuperOffice_WebApi_Data_Preference_SuperOffice_WebApi_RequestOptions_”></a> SavePreferenceAsync(Preference, RequestOptions)

Save this preference

Parameters

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. requestOptions RequestOptions Override language/culture codes on this request.

Returns

Task This method has no return value

<a id=“SuperOffice_WebApi_Agents_PreferenceAgent_SavePreferenceDescriptionAsync_SuperOffice_WebApi_Data_PreferenceDescription_SuperOffice_WebApi_RequestOptions_”></a> SavePreferenceDescriptionAsync(PreferenceDescription, RequestOptions)

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

Parameters

preferenceDescription PreferenceDescription The PreferenceDescription that is saved. requestOptions RequestOptions Override language/culture codes on this request.

Returns

Task<PreferenceDescription&gt; New or updated PreferenceDescription

<a id=“SuperOffice_WebApi_Agents_PreferenceAgent_SavePreferenceDescriptionLineAsync_SuperOffice_WebApi_Data_PreferenceDescriptionLine_SuperOffice_WebApi_RequestOptions_”></a> SavePreferenceDescriptionLineAsync(PreferenceDescriptionLine, RequestOptions)

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

Parameters

preferenceDescriptionLine PreferenceDescriptionLine The PreferenceDescriptionLine that is saved. requestOptions RequestOptions Override language/culture codes on this request.

Returns

Task<PreferenceDescriptionLine&gt; New or updated PreferenceDescriptionLine

<a id=“SuperOffice_WebApi_Agents_PreferenceAgent_SavePreferenceDescriptionLinesAsync_SuperOffice_WebApi_Data_PreferenceDescriptionLine___SuperOffice_WebApi_RequestOptions_”></a> SavePreferenceDescriptionLinesAsync(PreferenceDescriptionLine[], RequestOptions)

Saves the PreferenceDescriptionLine array in the SuperOffice database

Parameters

preferenceDescriptionLines PreferenceDescriptionLine[] The PreferenceDescriptionLine array to save. requestOptions RequestOptions Override language/culture codes on this request.

Returns

Task<PreferenceDescriptionLine[]&gt; The updated PrefDesc lines (If the PreferenceDescriptionLine array was new, it returns with id’s set.

<a id=“SuperOffice_WebApi_Agents_PreferenceAgent_SavePreferenceEntitiesAsync_SuperOffice_WebApi_Data_Preference___System_Boolean_SuperOffice_WebApi_RequestOptions_”></a> SavePreferenceEntitiesAsync(Preference[], bool, RequestOptions)

Save this set of preferences.

Parameters

preferences Preference[] Preferences to be saved. Note that all fields must be filled in. removeLowerLevels bool If this is true, all user preferences on lower levels will be deleted requestOptions RequestOptions Override language/culture codes on this request.

Returns

Task

<a id=“SuperOffice_WebApi_Agents_PreferenceAgent_SavePreferenceEntityAsync_SuperOffice_WebApi_Data_Preference_System_Boolean_SuperOffice_WebApi_RequestOptions_”></a> SavePreferenceEntityAsync(Preference, bool, RequestOptions)

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

Parameters

preference Preference The preference object to be saved removeLowerLevels bool If this is true, all user preferences on lower levels will be deleted requestOptions RequestOptions Override language/culture codes on this request.

Returns

Task<Preference&gt; Returns the saved preference

<a id=“SuperOffice_WebApi_Agents_PreferenceAgent_SavePreferencesAsync_SuperOffice_WebApi_Data_Preference___SuperOffice_WebApi_RequestOptions_”></a> SavePreferencesAsync(Preference[], RequestOptions)

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

Parameters

preferences Preference[] 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. requestOptions RequestOptions Override language/culture codes on this request.

Returns

Task

<a id=“SuperOffice_WebApi_Agents_PreferenceAgent_SaveTabOrderAsync_SuperOffice_WebApi_Data_TabOrder_SuperOffice_WebApi_RequestOptions_”></a> SaveTabOrderAsync(TabOrder, RequestOptions)

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

Parameters

tabOrder TabOrder Name of the tab control requestOptions RequestOptions Override language/culture codes on this request.

Returns

Task This method has no return value

<a id=“SuperOffice_WebApi_Agents_PreferenceAgent_SaveTabOrdersAsync_SuperOffice_WebApi_Data_TabOrder___SuperOffice_WebApi_RequestOptions_”></a> SaveTabOrdersAsync(TabOrder[], RequestOptions)

Parameters

tabOrders TabOrder[] requestOptions RequestOptions Override language/culture codes on this request.

Returns

Task

<a id=“SuperOffice_WebApi_Agents_PreferenceAgent_SetXsrfPathsAsync_System_String_System_String___SuperOffice_WebApi_RequestOptions_”></a> SetXsrfPathsAsync(string, string[], RequestOptions)

Update the paths that need XSRF cookies

Parameters

hostname string The hostname that we are storing paths for. paths string[] Paths that XSRF cookies should be set for: [‘/cs’, ‘/crm’] requestOptions RequestOptions Override language/culture codes on this request.

Returns

Task This method has no return value

<a id=“SuperOffice_WebApi_Agents_PreferenceAgent_SetXsrfValueAsync_System_String_SuperOffice_WebApi_RequestOptions_”></a> SetXsrfValueAsync(string, RequestOptions)

Sets the XSRF token value for the current user

Parameters

xsrfValue string The XSRF value to store requestOptions RequestOptions Override language/culture codes on this request.

Returns

Task This method has no return value

<a id=“SuperOffice_WebApi_Agents_PreferenceAgent_UpdateNetServicesStatusAsync_System_String_SuperOffice_WebApi_RequestOptions_”></a> UpdateNetServicesStatusAsync(string, RequestOptions)

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

Parameters

xml_or_json string The text that was returned by getting the Status URL requestOptions RequestOptions Override language/culture codes on this request.

Returns

Task This method has no return value