Skip to main content

<a id=“SuperOffice_WebApi_Agents_IBulkUpdateAgent”></a> Interface IBulkUpdateAgent

Namespace: SuperOffice.WebApi.Agents
Assembly: SuperOffice.WebApi.dll
Agent used for bulk update methods

Implements

IAgentBase, IDisposable

Methods

<a id=“SuperOffice_WebApi_Agents_IBulkUpdateAgent_ExecuteByEntityIdsAsync_SuperOffice_WebApi_Data_FieldValueInfo___System_String_System_String_System_String_SuperOffice_WebApi_RequestOptions_”></a> ExecuteByEntityIdsAsync(FieldValueInfo[], string, string, string, RequestOptions)

Do the batchupdate on selected

Parameters

fieldValueInfos FieldValueInfo[] The name of the wanted tablename tableName string The name of the table to bulk update context string Where is the function called from ids string Comma separated string of the ids of the entities to update requestOptions RequestOptions Override language/culture codes on this request.

Returns

Task<int&gt; Return batchtaskinfoid

<a id=“SuperOffice_WebApi_Agents_IBulkUpdateAgent_ExecuteBySelectionIdAsync_SuperOffice_WebApi_Data_FieldValueInfo___System_String_System_String_System_Int32_System_Boolean_SuperOffice_WebApi_RequestOptions_”></a> ExecuteBySelectionIdAsync(FieldValueInfo[], string, string, int, bool, RequestOptions)

Do the batchupdate on this selection

Parameters

fieldValueInfos FieldValueInfo[] The name of the wanted tablename tableName string The name of the table to bulk update context string Where is the function called for selectionId int The id of the selection isShadow bool Use the shadow selection requestOptions RequestOptions Override language/culture codes on this request.

Returns

Task<int&gt; Return batchtaskinfoid

<a id=“SuperOffice_WebApi_Agents_IBulkUpdateAgent_GetAvailableFieldsAsync_System_String_SuperOffice_WebApi_RequestOptions_”></a> GetAvailableFieldsAsync(string, RequestOptions)

Get all available fields for a given tablename/entity

Parameters

tablename string The name of the wanted tablename requestOptions RequestOptions Override language/culture codes on this request.

Returns

Task<FieldValueInfo[]&gt; Returns array of the available fields for the given entity

<a id=“SuperOffice_WebApi_Agents_IBulkUpdateAgent_GetJobResultAsJsonFromBinaryObjectIdAsync_System_String_System_Int32_SuperOffice_WebApi_RequestOptions_”></a> GetJobResultAsJsonFromBinaryObjectIdAsync(string, int, RequestOptions)

Get result of the batchupdate job

Parameters

tableName string The name of the table that was updated to show the log from binaryObjectId int Which binaryobject id has stored the job result requestOptions RequestOptions Override language/culture codes on this request.

Returns

Task<string&gt; Result of job as json

<a id=“SuperOffice_WebApi_Agents_IBulkUpdateAgent_GetJobResultsFromStorageAsJsonAsync_SuperOffice_WebApi_RequestOptions_”></a> GetJobResultsFromStorageAsJsonAsync(RequestOptions)

Get result of the batchupdate job

Parameters

requestOptions RequestOptions Override language/culture codes on this request.

Returns

Task<string[]&gt; Result of job as json

<a id=“SuperOffice_WebApi_Agents_IBulkUpdateAgent_GetStoredFieldsAsync_System_String_System_String_SuperOffice_WebApi_RequestOptions_”></a> GetStoredFieldsAsync(string, string, RequestOptions)

Get all stored fields for a given tablename/entity and context

Parameters

tablename string The name of the wanted tablename context string Where is the function called for requestOptions RequestOptions Override language/culture codes on this request.

Returns

Task<FieldValueInfo[]&gt; Returns array of the stored or default fields for the given entity

<a id=“SuperOffice_WebApi_Agents_IBulkUpdateAgent_RemoveStoredFieldsAndGetDefaultFieldsAsync_System_String_System_String_SuperOffice_WebApi_RequestOptions_”></a> RemoveStoredFieldsAndGetDefaultFieldsAsync(string, string, RequestOptions)

Remove the stored settings of the bulk update for this table from this context, to get the default settings instead

Parameters

tableName string The name of the table to remove stored settings from context string Where is the function called from that we will remove the settings from requestOptions RequestOptions Override language/culture codes on this request.

Returns

Task<FieldValueInfo[]&gt; Returns array of the available fields for the given tablename

<a id=“SuperOffice_WebApi_Agents_IBulkUpdateAgent_RemoveStoredFieldsAsync_System_String_System_String_SuperOffice_WebApi_RequestOptions_”></a> RemoveStoredFieldsAsync(string, string, RequestOptions)

Remove the stored settings of the bulk update for this table from this context

Parameters

tableName string The name of the table to remove stored settings from context string Where is the function called from that we will remove the settings from requestOptions RequestOptions Override language/culture codes on this request.

Returns

Task<bool&gt;