View Source

Interface IDictionaryItemImportService

Represents a service that provides functionality for importing dictionary items into the system.

Namespace: Umbraco.Cms.Api.Management.Services

Assembly: Umbraco.Cms.Api.Management.dll

Syntax

public interface IDictionaryItemImportService

Methods

ImportDictionaryItemFromUdtFileAsync(Guid, Guid?, Guid)

Asynchronously imports a dictionary item from a temporary UDT (Umbraco Dictionary Transfer) file.

Declaration

Task<Attempt<IDictionaryItem?, DictionaryImportOperationStatus>> ImportDictionaryItemFromUdtFileAsync(Guid temporaryFileKey, Guid? parentKey, Guid userKey)

Parameters

Type	Name	Description
Guid	temporaryFileKey	The unique key identifying the temporary UDT file to import from.
Guid?	parentKey	The optional key of the parent dictionary item under which the imported item will be placed. If null, the item is imported at the root level.
Guid	userKey	The key of the user performing the import operation.

Returns

Type	Description
Task<Attempt<IDictionaryItem, DictionaryImportOperationStatus>>	A System.Threading.Tasks.Task representing the asynchronous operation. The result contains an Attempt<TResult> with the imported IDictionaryItem (or null if unsuccessful) and the DictionaryImportOperationStatus indicating the outcome.