<a id=“SuperOffice_WebApi_Agents_ConfigurationAgent”></a> Class ConfigurationAgent
Namespace: SuperOffice.WebApi.AgentsAssembly: SuperOffice.WebApi.dll User interface configuration - XMLs and other elements such as inter-client URLs
Inheritance
object ← AgentBase ← ConfigurationAgentImplements
IConfigurationAgent, IAgentBase, IDisposableInherited 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>(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 (ConfigurationAgent agent = new ConfigurationAgent(mySession)) { // call methods on agent here… }</code></pre>Constructors
<a id=“SuperOffice_WebApi_Agents_ConfigurationAgent__ctor_System_Net_Http_HttpClient_”></a> ConfigurationAgent(HttpClient)
Constructor: User interface configuration - XMLs and other elements such as inter-client URLsParameters
httpClient HttpClient
Use this HTTP client instead of making own HttpClient instance.
<a id=“SuperOffice_WebApi_Agents_ConfigurationAgent__ctor_SuperOffice_WebApi_WebApiOptions_System_Net_Http_HttpClient_”></a> ConfigurationAgent(WebApiOptions, HttpClient)
Constructor: User interface configuration - XMLs and other elements such as inter-client URLsParameters
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_ConfigurationAgent_ClearConfigurationCacheAsync_System_String_System_String_System_Boolean_SuperOffice_WebApi_RequestOptions_”></a> ClearConfigurationCacheAsync(string, string, bool, RequestOptions)
Configuration XML’s may be expensive to build and parse, and are therefore cached to the database. <para/>Cahcing is per application/instance/associate, and can be turned off through the config file. <para/>If caching is on, and the configuration is changed, it is necessary to clear the cached configurations from the database, through this call.<para/>Note that changes to the externalapplication table require cache invalidation. SoAdmin will do so automatically.Parameters
application string
The application name, for instance ‘SixWeb’
instance string
The instance name for the application, like ‘MainInstance’
forAllAssociates bool
If false, only the current associate’s configuration is cleared. If true, configurations are cleared for all associates.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task There is no return value.<a id=“SuperOffice_WebApi_Agents_ConfigurationAgent_CreateDefaultConfigurableScreenDeltaAsync_SuperOffice_WebApi_RequestOptions_”></a> CreateDefaultConfigurableScreenDeltaAsync(RequestOptions)
Set default values into a new ConfigurableScreenDelta. NetServer calculates default values on the entity, which is required when creating/storing a new instanceParameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<ConfigurableScreenDelta> A blank ConfigurableScreenDelta<a id=“SuperOffice_WebApi_Agents_ConfigurationAgent_CreateDefaultDiaryViewEntityAsync_SuperOffice_WebApi_RequestOptions_”></a> CreateDefaultDiaryViewEntityAsync(RequestOptions)
Set default values into a new DiaryViewEntity. NetServer calculates default values on the entity, which is required when creating/storing a new instanceParameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<DiaryViewEntity> A blank DiaryViewEntity<a id=“SuperOffice_WebApi_Agents_ConfigurationAgent_CreateDefaultLandingPageEntityAsync_SuperOffice_WebApi_RequestOptions_”></a> CreateDefaultLandingPageEntityAsync(RequestOptions)
Set default values into a new LandingPageEntity. NetServer calculates default values on the entity, which is required when creating/storing a new instanceParameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<LandingPageEntity> A blank LandingPageEntity<a id=“SuperOffice_WebApi_Agents_ConfigurationAgent_CreateDefaultSystemEventEntityAsync_SuperOffice_WebApi_RequestOptions_”></a> CreateDefaultSystemEventEntityAsync(RequestOptions)
Set default values into a new SystemEventEntity. NetServer calculates default values on the entity, which is required when creating/storing a new instanceParameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<SystemEventEntity> A blank SystemEventEntity<a id=“SuperOffice_WebApi_Agents_ConfigurationAgent_DeleteConfigurableScreenDeltaAsync_System_Int32_SuperOffice_WebApi_RequestOptions_”></a> DeleteConfigurableScreenDeltaAsync(int, RequestOptions)
Deletes the ConfigurableScreenDeltaParameters
configurableScreenDeltaId int
The identity of the ConfigurableScreenDelta
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<a id=“SuperOffice_WebApi_Agents_ConfigurationAgent_DeleteDiaryViewEntityAsync_System_Int32_SuperOffice_WebApi_RequestOptions_”></a> DeleteDiaryViewEntityAsync(int, RequestOptions)
Deletes the DiaryViewEntityParameters
diaryViewEntityId int
The identity of the DiaryViewEntity
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<a id=“SuperOffice_WebApi_Agents_ConfigurationAgent_DeleteLandingPageEntityAsync_System_Int32_SuperOffice_WebApi_RequestOptions_”></a> DeleteLandingPageEntityAsync(int, RequestOptions)
Deletes the LandingPageEntityParameters
landingPageEntityId int
The identity of the LandingPageEntity
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<a id=“SuperOffice_WebApi_Agents_ConfigurationAgent_DeleteSystemEventEntityAsync_System_Int32_SuperOffice_WebApi_RequestOptions_”></a> DeleteSystemEventEntityAsync(int, RequestOptions)
Deletes the SystemEventEntityParameters
systemEventEntityId int
The identity of the SystemEventEntity
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<a id=“SuperOffice_WebApi_Agents_ConfigurationAgent_DeleteWindowPosSizeAsync_System_Int32_SuperOffice_WebApi_RequestOptions_”></a> DeleteWindowPosSizeAsync(int, RequestOptions)
Deletes a window and dialog position and size setting.Parameters
windowPosSizeId int
Id of the window and dialog position and size settings item.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<a id=“SuperOffice_WebApi_Agents_ConfigurationAgent_ExistsSystemEventAsync_System_String_SuperOffice_WebApi_RequestOptions_”></a> ExistsSystemEventAsync(string, RequestOptions)
Is there a system event with the given key?Parameters
key string
The key to match on
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<bool> The system event<a id=“SuperOffice_WebApi_Agents_ConfigurationAgent_GetAllFeatureTogglesAsync_SuperOffice_WebApi_RequestOptions_”></a> GetAllFeatureTogglesAsync(RequestOptions)
Get all the feature toggles with their state (on/off)Parameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<StringBoolDictionary> The feature toggles with their state (on/off)<a id=“SuperOffice_WebApi_Agents_ConfigurationAgent_GetAnyConfigurationAsync_System_String_System_String_System_String_System_String_SuperOffice_WebApi_RequestOptions_”></a> GetAnyConfigurationAsync(string, string, string, string, RequestOptions)
Get one defined configuration fragment, with full reference resolution and parsing applied. This is essentially the same service as the GetPageConfiguration, except that this service is not locked to objects of type Page.Parameters
application string
The application name, for instance Six.Web
instance string
The instance name, for instance Main
item string
The configuration item name (first component of file name)
type string
The configuration item type (second component of file name)
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<string> Fully resolved and parsed configuration XML, as string.<a id=“SuperOffice_WebApi_Agents_ConfigurationAgent_GetApplicationConfigurationAsync_System_String_System_String_SuperOffice_WebApi_RequestOptions_”></a> GetApplicationConfigurationAsync(string, string, RequestOptions)
Return the application configuration. This is a list of pages, with information about the name, main panel and preference mappings of each page.Parameters
application string
The application name, for instance ‘SixWeb’
instance string
The instance name for the application, like ‘MainInstance’
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<string> XML structure containing the application configuration<a id=“SuperOffice_WebApi_Agents_ConfigurationAgent_GetCRMUrlAsync_System_String_System_String_System_Boolean_SuperOffice_WebApi_RequestOptions_”></a> GetCRMUrlAsync(string, string, bool, RequestOptions)
Returns a valid url based in the soprotocol providedParameters
soProtocol string
SoProtocol to display. Eg. contact.activityarchive.minipreview
currents string
currents to set. Eg. contact_id=100&person_id=299
frameless bool
If true frame is not rendered( Navigationbar, buttonbar and menu )
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<string> Url with soprotocol<a id=“SuperOffice_WebApi_Agents_ConfigurationAgent_GetCSAuthUrlAsync_System_String_System_String_System_String_System_String_SuperOffice_WebApi_RequestOptions_”></a> GetCSAuthUrlAsync(string, string, string, string, RequestOptions)
Will generate an url to the emarketing moduleParameters
language string
By setting this parameter, you can change the CS language for the current user.
programName string
In this parameter you must specify which CS program you want to create an URL for. Valid examples are “ticket”, “rms”, “spm” etc.
action string
Here you can optionally specify the action for the current program. This will enable you to go to a specific screen.
extraParameters string
If an action is specified, you can specify extra parameters here. This can be used to set specific behaviour for the chosen screen/action. If an empty action is supplied, this parameter will be ignored.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<string> Returns a valid CS URL composed of the give parameters.<a id=“SuperOffice_WebApi_Agents_ConfigurationAgent_GetCSRegistryValueAsync_System_Int32_SuperOffice_WebApi_RequestOptions_”></a> GetCSRegistryValueAsync(int, RequestOptions)
This method will get a value from the CS Registry table.Parameters
entry int
The Registry entry to get
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<string> The value of the specified Registry entry<a id=“SuperOffice_WebApi_Agents_ConfigurationAgent_GetCSWwwFolderAsync_SuperOffice_WebApi_RequestOptions_”></a> GetCSWwwFolderAsync(RequestOptions)
This method will get the www folder for CSParameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<string> The www folder for CS<a id=“SuperOffice_WebApi_Agents_ConfigurationAgent_GetConfigurableScreenDeltaAsync_System_Int32_SuperOffice_WebApi_RequestOptions_”></a> GetConfigurableScreenDeltaAsync(int, RequestOptions)
Gets a specific ConfigurableScreenDelta object.Parameters
configurableScreenDeltaId int
The identifier of the ConfigurableScreenDelta object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<ConfigurableScreenDelta> ConfigurableScreenDelta<a id=“SuperOffice_WebApi_Agents_ConfigurationAgent_GetConfigurableScreenDeltasByDeltaAsync_SuperOffice_WebApi_Data_ConfigurableScreenDelta_SuperOffice_WebApi_RequestOptions_”></a> GetConfigurableScreenDeltasByDeltaAsync(ConfigurableScreenDelta, RequestOptions)
This method will return a configurablescreen delta matching the properties received from the incomming deltaParameters
configurableScreenDelta ConfigurableScreenDelta
A delta populated with wanted properties
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<ConfigurableScreenDelta[]> An array of deltas matching the values of the incomming parameter-delta<a id=“SuperOffice_WebApi_Agents_ConfigurationAgent_GetConfigurableScreenDeltasByQueryAsync_SuperOffice_WebApi_Data_DeltaQuery_SuperOffice_WebApi_RequestOptions_”></a> GetConfigurableScreenDeltasByQueryAsync(DeltaQuery, RequestOptions)
This method will return a configurablescreen delta matching the properties received from the incomming queryParameters
deltaQuery DeltaQuery
An object populated with wanted properties for the deltas to return
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<ConfigurableScreenDelta[]> An array of deltas matching the values of the incomming query<a id=“SuperOffice_WebApi_Agents_ConfigurationAgent_GetCsCgiUrlAsync_SuperOffice_WebApi_RequestOptions_”></a> GetCsCgiUrlAsync(RequestOptions)
This method will get the host name for external CSParameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<string> Will get the host name for where CS Customer Center is installed<a id=“SuperOffice_WebApi_Agents_ConfigurationAgent_GetCsCgiUrlInternalAsync_SuperOffice_WebApi_RequestOptions_”></a> GetCsCgiUrlInternalAsync(RequestOptions)
This method will get the host name for CSParameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<string> Will get the host name for where CS is installed<a id=“SuperOffice_WebApi_Agents_ConfigurationAgent_GetCsProgramUrlAsync_System_String_System_String_System_String_System_String_SuperOffice_WebApi_RequestOptions_”></a> GetCsProgramUrlAsync(string, string, string, string, RequestOptions)
This method will convert a module name into a CS URL.Parameters
language string
By setting this parameter, you can change the CS language for the current user.
programName string
In this parameter you must specify which CS program you want to create an URL for. Valid examples are “ticket”, “rms”, “spm” etc.
action string
Here you can optionally specify the action for the current program. This will enable you to go to a specific screen.
extraParameters string
If an action is specified, you can specify extra parameters here. This can be used to set specific behaviour for the chosen screen/action. If an empty action is supplied, this parameter will be ignored.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<string> Returns a valid CS URL composed of the give parameters.<a id=“SuperOffice_WebApi_Agents_ConfigurationAgent_GetCustomerUrlAsync_SuperOffice_WebApi_RequestOptions_”></a> GetCustomerUrlAsync(RequestOptions)
This method will get the URL for the external access to the customer centerParameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<string> The URL to the customer center, without any actions<a id=“SuperOffice_WebApi_Agents_ConfigurationAgent_GetDiaryViewEntityAsync_System_Int32_SuperOffice_WebApi_RequestOptions_”></a> GetDiaryViewEntityAsync(int, RequestOptions)
Gets a specific DiaryViewEntity object.Parameters
diaryViewEntityId int
The identifier of the DiaryViewEntity object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<DiaryViewEntity> DiaryViewEntity<a id=“SuperOffice_WebApi_Agents_ConfigurationAgent_GetEMarketingUrlAsync_System_String_SuperOffice_WebApi_RequestOptions_”></a> GetEMarketingUrlAsync(string, RequestOptions)
Parameters
language string
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<string><a id=“SuperOffice_WebApi_Agents_ConfigurationAgent_GetEmailNumberOfDaysAsync_SuperOffice_WebApi_RequestOptions_”></a> GetEmailNumberOfDaysAsync(RequestOptions)
Parameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<int> Number of days in the past for which we are fetching email<a id=“SuperOffice_WebApi_Agents_ConfigurationAgent_GetFilterListAsync_System_String_System_String_SuperOffice_WebApi_RequestOptions_”></a> GetFilterListAsync(string, string, RequestOptions)
Get the list of filters to be used for processing the configuration data for this application.Parameters
application string
The application name, for instance ‘SixWeb’
instance string
The instance name for the application, like ‘MainInstance’
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<string> XML representing the list of filters and any configuration data they may need.<a id=“SuperOffice_WebApi_Agents_ConfigurationAgent_GetHelpDispatcherUrlAsync_SuperOffice_WebApi_RequestOptions_”></a> GetHelpDispatcherUrlAsync(RequestOptions)
Will get the GetHelpDispatcherUrl used by the help systemParameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<string> URL to be used by the help system<a id=“SuperOffice_WebApi_Agents_ConfigurationAgent_GetLandingPageAsync_System_Int32_System_String_SuperOffice_WebApi_RequestOptions_”></a> GetLandingPageAsync(int, string, RequestOptions)
Get the landing page configuration for an associate and entity table. Creates the landing page row if it does not exist.Parameters
associateId int
Id of the associate.
tableName string
Entity table name (contact, person, sale, …), transformed to and from the numeric table number by the service layer.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<LandingPageEntity> The landing page for the given associate and entity table.<a id=“SuperOffice_WebApi_Agents_ConfigurationAgent_GetLandingPageEntityAsync_System_Int32_SuperOffice_WebApi_RequestOptions_”></a> GetLandingPageEntityAsync(int, RequestOptions)
Gets a specific LandingPageEntity object.Parameters
landingPageEntityId int
The identifier of the LandingPageEntity object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<LandingPageEntity> LandingPageEntity<a id=“SuperOffice_WebApi_Agents_ConfigurationAgent_GetMyWindowPosSizesAsync_SuperOffice_WebApi_RequestOptions_”></a> GetMyWindowPosSizesAsync(RequestOptions)
Gets the window and dialog position and size settings belonging to the currently logged on userParameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<WindowPosSize[]> Array of window and dialog position and size settings<a id=“SuperOffice_WebApi_Agents_ConfigurationAgent_GetObjectMappingAsync_System_String_System_String_SuperOffice_WebApi_RequestOptions_”></a> GetObjectMappingAsync(string, string, RequestOptions)
Get the object mappings, i.e., the what code objects should be instantiated to handle the entities of the client configuration.Parameters
application string
The application name, for instance ‘SixWeb’
instance string
The instance name for the application, like ‘MainInstance’
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<string> XML containing the object mappings, including assembly and class names<a id=“SuperOffice_WebApi_Agents_ConfigurationAgent_GetPageConfigurationAsync_System_String_System_String_System_String_SuperOffice_WebApi_RequestOptions_”></a> GetPageConfigurationAsync(string, string, string, RequestOptions)
Get the configuration for one whole web page, including all its panels etc. totally asynchronous items like menus are not included, but all references are resolved and all special processing is applied.Parameters
application string
The application name, for instance ‘SixWeb
instance string
The instance name for the application, like ‘MainInstance’
page string
Page name, must correspond to one of the pages in the Application Configuration
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<string> XML containing the configuration for the given page, from the page down to the control level.<a id=“SuperOffice_WebApi_Agents_ConfigurationAgent_GetRecipeAppliesToMappingsAsync_SuperOffice_WebApi_RequestOptions_”></a> GetRecipeAppliesToMappingsAsync(RequestOptions)
Return the a dictionary with recipeId as key, and chosen appliesTo for that recipe, Like projecttype for projectcardrecipeParameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<StringDictionary> Mapping of recipeId and selected appliesToKey<a id=“SuperOffice_WebApi_Agents_ConfigurationAgent_GetRefreshedPageConfigurationAsync_System_String_System_String_System_String_SuperOffice_WebApi_RequestOptions_”></a> GetRefreshedPageConfigurationAsync(string, string, string, RequestOptions)
Get the configuration for one whole web page, including all its panels etc. totally asynchronous items like menus are not included, but all references are resolved and all special processing is applied. Does not use cache for fetching, but updates the cache with refreshed configuration.Parameters
application string
The application name, for instance ‘SixWeb
instance string
The instance name for the application, like ‘MainInstance’
page string
Page name, must correspond to one of the pages in the Application Configuration
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<string> XML containing the configuration for the given page, from the page down to the control level.<a id=“SuperOffice_WebApi_Agents_ConfigurationAgent_GetScreenConfigurationDeltaAsync_SuperOffice_WebApi_Data_DeltaType_SuperOffice_WebApi_Data_DeltaState_SuperOffice_WebApi_RequestOptions_”></a> GetScreenConfigurationDeltaAsync(DeltaType, DeltaState, RequestOptions)
This method will return a json with all deltas for screenParameters
deltaType DeltaType
The recipe in json for this DeltaType: System, WebPanel, CustomFields, Custom…
deltaState DeltaState
Draft or published or None
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<string> A string with recipe delta in json for logged in associate of given deltatype<a id=“SuperOffice_WebApi_Agents_ConfigurationAgent_GetScreenConfigurationDeltasAsync_SuperOffice_WebApi_RequestOptions_”></a> GetScreenConfigurationDeltasAsync(RequestOptions)
This method will return a json with all deltas for screenParameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<string> A string with all recipe deltas in json for logged in associate<a id=“SuperOffice_WebApi_Agents_ConfigurationAgent_GetSpfDomainAsync_SuperOffice_WebApi_RequestOptions_”></a> GetSpfDomainAsync(RequestOptions)
Get the SPF domain defined for the mail cluster for this tenant (Online only)Parameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<string> The configured SPF domain. Will return empty for Onsite installations or tenants in Online using custom SMTP<a id=“SuperOffice_WebApi_Agents_ConfigurationAgent_GetSystemEventEntityAsync_System_Int32_SuperOffice_WebApi_RequestOptions_”></a> GetSystemEventEntityAsync(int, RequestOptions)
Gets a specific SystemEventEntity object.Parameters
systemEventEntityId int
The identifier of the SystemEventEntity object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<SystemEventEntity> SystemEventEntity<a id=“SuperOffice_WebApi_Agents_ConfigurationAgent_GetWindowPosSizeAsync_System_Int32_SuperOffice_WebApi_RequestOptions_”></a> GetWindowPosSizeAsync(int, RequestOptions)
Gets a specific WindowPosSize object.Parameters
windowPosSizeId int
The identifier of the WindowPosSize object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<WindowPosSize> WindowPosSize<a id=“SuperOffice_WebApi_Agents_ConfigurationAgent_GetWindowPosSizeListAsync_System_Int32___SuperOffice_WebApi_RequestOptions_”></a> GetWindowPosSizeListAsync(int[], RequestOptions)
Gets an array of specific WindowPosSize objects.Parameters
windowPosSizeIds int[]
The identifiers of the WindowPosSize object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<WindowPosSize[]> Array of WindowPosSize objects<a id=“SuperOffice_WebApi_Agents_ConfigurationAgent_GetWindowPosSizesOnAssociateIdAsync_System_Int32_SuperOffice_WebApi_RequestOptions_”></a> GetWindowPosSizesOnAssociateIdAsync(int, RequestOptions)
Gets the window and dialog position and size settings belonging to the specified associateParameters
associateId int
Associate id of the Associate/Person owning these window settings
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<WindowPosSize[]> Array of window and dialog position and size settings<a id=“SuperOffice_WebApi_Agents_ConfigurationAgent_GetWindowPosSizesOnPersonIdAsync_System_Int32_SuperOffice_WebApi_RequestOptions_”></a> GetWindowPosSizesOnPersonIdAsync(int, RequestOptions)
Gets the window and dialog position and size settings belonging to the specified personParameters
personId int
Person id of the associate owning these window settings
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<WindowPosSize[]> Array of window and dialog position and size settings<a id=“SuperOffice_WebApi_Agents_ConfigurationAgent_GetWwwUrlAsync_System_String_SuperOffice_WebApi_RequestOptions_”></a> GetWwwUrlAsync(string, RequestOptions)
Will get the default URL used for the logo, from the [NetServices] PageUrl preferencec, with tags substituted.Parameters
client string
The name for the client application, like ‘CS’ or ‘SM.web’, used for the <clie> variable
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<string> URL to be used when clicking the logo<a id=“SuperOffice_WebApi_Agents_ConfigurationAgent_GetWwwUrlForSMWebAsync_SuperOffice_WebApi_RequestOptions_”></a> GetWwwUrlForSMWebAsync(RequestOptions)
Returns the URL used for the logo by the SM.web client. Uses urldispatch.aspxParameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<string> Link to urldispatch.aspx tagged with [SOSITEURL]<a id=“SuperOffice_WebApi_Agents_ConfigurationAgent_RebuildCustomObjectArchivePanelDeltasAsync_SuperOffice_WebApi_RequestOptions_”></a> RebuildCustomObjectArchivePanelDeltasAsync(RequestOptions)
Flush and rebuild CustomObjectArchivePanel deltas.Parameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task No return value<a id=“SuperOffice_WebApi_Agents_ConfigurationAgent_RebuildTaskMenuDeltasAsync_SuperOffice_WebApi_RequestOptions_”></a> RebuildTaskMenuDeltasAsync(RequestOptions)
Flush and rebuild TaskMenu deltas.Parameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task No return value<a id=“SuperOffice_WebApi_Agents_ConfigurationAgent_RebuildUdefDeltasAsync_SuperOffice_WebApi_RequestOptions_”></a> RebuildUdefDeltasAsync(RequestOptions)
Flush and rebuild userdefined field deltas. Mostly used after publishing udefs or adding/editing Customer Service extrafieldsParameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task No return value<a id=“SuperOffice_WebApi_Agents_ConfigurationAgent_RebuildWebpanelDeltasAsync_SuperOffice_WebApi_RequestOptions_”></a> RebuildWebpanelDeltasAsync(RequestOptions)
Flush and rebuild webpanel deltas. Mostly used after adding/editing webpanels or change group visibility of themParameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task No return value<a id=“SuperOffice_WebApi_Agents_ConfigurationAgent_SaveAndPublishAsync_SuperOffice_WebApi_Data_ConfigurableScreenDelta_SuperOffice_WebApi_RequestOptions_”></a> SaveAndPublishAsync(ConfigurableScreenDelta, RequestOptions)
Save the incomming draft and publishParameters
configurableScreenDelta ConfigurableScreenDelta
The ConfigurableScreenDelta draft that is going to be published
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<ConfigurableScreenDelta> The newly published version of the ConfigurbleScreenDelta<a id=“SuperOffice_WebApi_Agents_ConfigurationAgent_SaveConfigurableScreenDeltaAsync_SuperOffice_WebApi_Data_ConfigurableScreenDelta_SuperOffice_WebApi_RequestOptions_”></a> SaveConfigurableScreenDeltaAsync(ConfigurableScreenDelta, RequestOptions)
Updates the existing ConfigurableScreenDelta or creates a new ConfigurableScreenDelta if the id parameter is 0.Parameters
configurableScreenDelta ConfigurableScreenDelta
The ConfigurableScreenDelta that is saved.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<ConfigurableScreenDelta> New or updated ConfigurableScreenDelta<a id=“SuperOffice_WebApi_Agents_ConfigurationAgent_SaveDiaryViewEntityAsync_SuperOffice_WebApi_Data_DiaryViewEntity_SuperOffice_WebApi_RequestOptions_”></a> SaveDiaryViewEntityAsync(DiaryViewEntity, RequestOptions)
Updates the existing DiaryViewEntity or creates a new DiaryViewEntity if the id parameter is 0.Parameters
diaryViewEntity DiaryViewEntity
The DiaryViewEntity that is saved.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<DiaryViewEntity> New or updated DiaryViewEntity<a id=“SuperOffice_WebApi_Agents_ConfigurationAgent_SaveLandingPageEntityAsync_SuperOffice_WebApi_Data_LandingPageEntity_SuperOffice_WebApi_RequestOptions_”></a> SaveLandingPageEntityAsync(LandingPageEntity, RequestOptions)
Updates the existing LandingPageEntity or creates a new LandingPageEntity if the id parameter is 0.Parameters
landingPageEntity LandingPageEntity
The LandingPageEntity that is saved.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<LandingPageEntity> New or updated LandingPageEntity<a id=“SuperOffice_WebApi_Agents_ConfigurationAgent_SaveSystemEventEntityAsync_SuperOffice_WebApi_Data_SystemEventEntity_SuperOffice_WebApi_RequestOptions_”></a> SaveSystemEventEntityAsync(SystemEventEntity, RequestOptions)
Updates the existing SystemEventEntity or creates a new SystemEventEntity if the id parameter is 0.Parameters
systemEventEntity SystemEventEntity
The SystemEventEntity that is saved.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<SystemEventEntity> New or updated SystemEventEntity<a id=“SuperOffice_WebApi_Agents_ConfigurationAgent_SaveWindowPosSizeAsync_SuperOffice_WebApi_Data_WindowPosSize_SuperOffice_WebApi_RequestOptions_”></a> SaveWindowPosSizeAsync(WindowPosSize, RequestOptions)
Saves a window and dialog position and size setting.Parameters
windowPosSize WindowPosSize
The item that is saved
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<WindowPosSize> The saved item<a id=“SuperOffice_WebApi_Agents_ConfigurationAgent_SaveWindowPosSizesAsync_SuperOffice_WebApi_Data_WindowPosSize___SuperOffice_WebApi_RequestOptions_”></a> SaveWindowPosSizesAsync(WindowPosSize[], RequestOptions)
Saves a set of window and dialog position and size settings.Parameters
windowPosSizes WindowPosSize[]
The items that are saved
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<WindowPosSize[]> The saved items<a id=“SuperOffice_WebApi_Agents_ConfigurationAgent_SetAppliesToKeyAsync_System_String_System_String_SuperOffice_WebApi_RequestOptions_”></a> SetAppliesToKeyAsync(string, string, RequestOptions)
Set the type of assignTo the deltas of the given recipe should haveParameters
recipeId string
The recipeId that will use this apply to type
appliesToKey string
The type we should use for differencing between delta layout. Like usergroup or project type. Saved in table ConfigurableScreenAppliesTo
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task Returns nothing<a id=“SuperOffice_WebApi_Agents_ConfigurationAgent_SetLandingPagePinForAssociateAsync_System_Boolean_System_Int32_System_String_System_String_System_Int32_SuperOffice_WebApi_RequestOptions_”></a> SetLandingPagePinForAssociateAsync(bool, int, string, string, int, RequestOptions)
Pin or unpin an entity or selection on the landing page identified by associate and entity table. Creates the landing page row if it does not exist.Parameters
pin bool
True to pin the item, false to unpin it.
associateId int
Id of the associate that owns the landing page.
entityTableName string
Entity table name identifying which landing page (contact, person, sale, …).
pinTableName string
Table name of the record being pinned (selection, contact, person, sale, …).
recordId int
Id of the record to pin or unpin.
requestOptions RequestOptions
Override language/culture codes on this request.