Loading...

Interface IAssetsStorage

Represents base functionality of resource storage, common for report definitions and resources.

Namespace: Telerik.WebReportDesigner.Services
Assembly: Telerik.WebReportDesigner.Services.dll

Syntax

public interface IAssetsStorage

Methods

CreateFolderAsync(CreateFolderModel)

Creates the given folder (Name) in ParentUri

Declaration
Task<ResourceFolderModel> CreateFolderAsync(CreateFolderModel model)
Parameters
CreateFolderModel model

The model containing the create operation data
Returns
System.Threading.Tasks.Task<ResourceFolderModel>

The ResourceFolderModel of the newly created folder

DeleteAsync(String)

Deletes the given resource

Declaration
Task DeleteAsync(string uri)
Parameters
System.String uri

The unique resource identifier (URI)
Returns
System.Threading.Tasks.Task

DeleteFolderAsync(String)

Deletes the given folder at uri

Declaration
Task DeleteFolderAsync(string uri)
Parameters
System.String uri

The unique resource identifier (URI)
Returns
System.Threading.Tasks.Task

GetAsync(String)

Finds a resource by its name and returns its contents as byte array.

Declaration
Task<byte[]> GetAsync(string resourceName)
Parameters
System.String resourceName

Returns
System.Threading.Tasks.Task<System.Byte[]>

System.Threading.Tasks.Task<TResult>, where TResult is System.Byte[], containing the resource bytes.
Remarks

Must throw a ReportNotFoundException when the requested resourceName represents a report definition and was not found. Must throw a ResourceNotFoundException when the requested resourceName represents a resource and was not found.

GetFolderAsync(String)

Returns the folder model at uri or null if not found.

Declaration
Task<ResourceFolderModel> GetFolderAsync(string uri)
Parameters
System.String uri

The unique resource identifier (URI).
Returns
System.Threading.Tasks.Task<ResourceFolderModel>

The ResourceFolderModel of the obtained folder.

GetFolderContentsAsync(String)

Gets all resources contained in the given uri

Declaration
Task<IEnumerable<ResourceModelBase>> GetFolderContentsAsync(string uri)
Parameters
System.String uri

The unique resource identifier (URI) of the folder
Returns
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<ResourceModelBase>>

A list of all resources found in the folder as an enumerable of ResourceModelBase

GetModelAsync(String)

Returns the resource model at uri or null if not found.

Declaration
Task<ResourceFileModel> GetModelAsync(string uri)
Parameters
System.String uri

The unique resource identifier (URI) of the resource.
Returns
System.Threading.Tasks.Task<ResourceFileModel>

ResourceFileModel, containg the information about the resource.

RenameAsync(RenameResourceModel)

Renames the given resource

Declaration
Task<ResourceFileModel> RenameAsync(RenameResourceModel model)
Parameters
RenameResourceModel model

The model containing the rename operation data
Returns
System.Threading.Tasks.Task<ResourceFileModel>

ResourceFileModel, containg the information about the file.

RenameFolderAsync(RenameFolderModel)

Renames the given folder at OldUri to Name.

Declaration
Task<ResourceFolderModel> RenameFolderAsync(RenameFolderModel model)
Parameters
RenameFolderModel model

The model containing the rename operation data
Returns
System.Threading.Tasks.Task<ResourceFolderModel>

The ResourceFolderModel of the newly created folder

SaveAsync(SaveResourceModel, Byte[])

Saves the raw data of a resource and returns its model.

Declaration
Task<ResourceFileModel> SaveAsync(SaveResourceModel model, byte[] resource)
Parameters
SaveResourceModel model

The model containing the save operation data.
System.Byte[] resource

The contents of the resource.
Returns
System.Threading.Tasks.Task<ResourceFileModel>

ResourceFileModel, containg the information about the saved resource.