<a id=“SuperOffice_WebApi_Agents_IResourceAgent”></a> Interface IResourceAgent
Namespace: SuperOffice.WebApi.AgentsAssembly: SuperOffice.WebApi.dll String resource substitution management.
Implements
IAgentBase, IDisposableMethods
<a id=“SuperOffice_WebApi_Agents_IResourceAgent_ActivateResourceSubstitutionAsync_System_String_System_String_System_Boolean_SuperOffice_WebApi_RequestOptions_”></a> ActivateResourceSubstitutionAsync(string, string, bool, RequestOptions)
Activate or deactive a resource substitution for one or more culturesParameters
resourceName string
The name of the resource, without any brackets; if blank then this is the MASTER SWITCH for the override system
culture string
The .NET culture string; if blank, then ALL substitutions for this resource will be affected
isActive bool
New status of override
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task This method has no return value<a id=“SuperOffice_WebApi_Agents_IResourceAgent_DeleteResourceSubstitutionAsync_System_String_System_String_SuperOffice_WebApi_RequestOptions_”></a> DeleteResourceSubstitutionAsync(string, string, RequestOptions)
Permanentely delete a resource substitution for one or more culturesParameters
resourceName string
The name of the resource, without any brackets
culture string
The .NET culture string; if blank, then ALL substitutions for this resource will be dropped
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task This method has no return value<a id=“SuperOffice_WebApi_Agents_IResourceAgent_GetResourceSubstitutionsAsync_System_String___System_String_System_Boolean_SuperOffice_WebApi_RequestOptions_”></a> GetResourceSubstitutionsAsync(string[], string, bool, RequestOptions)
Get substitutions for some or all resources for one cultureParameters
resourceNames string[]
Array of names of resources for which overrides are sought; if empty, then get all
culture string
.NET culture string; if empty, then get all
activeOnly bool
If true, then only resources with active substitutions will be returned; if false then ALL existing overrides will be returned
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<ResourceOverride[]> Array of override objects, empty if there are none<a id=“SuperOffice_WebApi_Agents_IResourceAgent_IsResourceSubstitutionActiveAsync_System_String___System_String_SuperOffice_WebApi_RequestOptions_”></a> IsResourceSubstitutionActiveAsync(string[], string, RequestOptions)
Determine if resource substitution/override is active, globally or for a subset of resources/culturesParameters
resourceNames string[]
Array of names of resources for which overrides are sought; if empty, then get the MASTER on/off
culture string
.NET culture string; if empty, then get for all cultures (unless resourceName
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<ResourceOverride[]> Array of override objects, empty if there are none; the ResourceValue member is not set by this call<a id=“SuperOffice_WebApi_Agents_IResourceAgent_SetResourceSubstitutionAsync_System_String_System_String_System_String_System_Boolean_SuperOffice_WebApi_RequestOptions_”></a> SetResourceSubstitutionAsync(string, string, string, bool, RequestOptions)
Create or update a resource substitutionParameters
resourceName string
The name of the resource, without any brackets
resourceValues string
The new value of the resource
culture string
The .NET culture string
isActive bool
Is the subsitution now active
requestOptions RequestOptions
Override language/culture codes on this request.