<a id=βSuperOffice_WebApi_Agents_INumberAllocationAgentβ></a> Interface INumberAllocationAgent
Namespace: SuperOffice.WebApi.AgentsAssembly: SuperOffice.WebApi.dll This agent can be used to manage number allocation
Implements
IAgentBase, IDisposableMethods
<a id=βSuperOffice_WebApi_Agents_INumberAllocationAgent_CreateDefaultRefCountEntityAsync_SuperOffice_WebApi_RequestOptions_β></a> CreateDefaultRefCountEntityAsync(RequestOptions)
Set default values into a new RefCountEntity. 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<RefCountEntity> A blank RefCountEntity<a id=βSuperOffice_WebApi_Agents_INumberAllocationAgent_DeleteRefCountEntityAsync_System_Int32_SuperOffice_WebApi_RequestOptions_β></a> DeleteRefCountEntityAsync(int, RequestOptions)
Deletes the RefCountEntityParameters
refCountEntityId int
The identity of the RefCountEntity
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<a id=βSuperOffice_WebApi_Agents_INumberAllocationAgent_GetNumberEachTemplateAsync_SuperOffice_WebApi_RequestOptions_β></a> GetNumberEachTemplateAsync(RequestOptions)
Returns true or false if Automatically create new counters for new document templatesParameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<bool> Is NumberEachTemplate?<a id=βSuperOffice_WebApi_Agents_INumberAllocationAgent_GetRefCountEntityAsync_System_Int32_SuperOffice_WebApi_RequestOptions_β></a> GetRefCountEntityAsync(int, RequestOptions)
Gets a specific RefCountEntity object.Parameters
refCountEntityId int
The identifier of the RefCountEntity object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<RefCountEntity> RefCountEntity<a id=βSuperOffice_WebApi_Agents_INumberAllocationAgent_SaveDefaultNumberingAsync_SuperOffice_WebApi_Data_RefCountEntity_SuperOffice_WebApi_RequestOptions_β></a> SaveDefaultNumberingAsync(RefCountEntity, RequestOptions)
Saves default numbering values in preferencesParameters
refCountEntity RefCountEntity
The refCountEntity that holds the values that will be saved
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task void<a id=βSuperOffice_WebApi_Agents_INumberAllocationAgent_SaveRefCountEntityAsync_SuperOffice_WebApi_Data_RefCountEntity_SuperOffice_WebApi_RequestOptions_β></a> SaveRefCountEntityAsync(RefCountEntity, RequestOptions)
Updates the existing RefCountEntity or creates a new RefCountEntity if the id parameter is 0.Parameters
refCountEntity RefCountEntity
The RefCountEntity that is saved.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<RefCountEntity> New or updated RefCountEntity<a id=βSuperOffice_WebApi_Agents_INumberAllocationAgent_SetNumberEachTemplateAsync_System_Boolean_SuperOffice_WebApi_RequestOptions_β></a> SetNumberEachTemplateAsync(bool, RequestOptions)
Saves true or false if Automatically create new counters for new document templatesParameters
setValue bool
true or false if Automatically create new counters for new document templates
requestOptions RequestOptions
Override language/culture codes on this request.