Class StorageSettings

Defines methods to process the SSRS, RDL, and RDLC reports.

Inheritance

System.Object

StorageSettings

Namespace: BoldReports.Web

Assembly: BoldReports.Web.dll

Syntax

public abstract class StorageSettings : Object

Constructors

StorageSettings()

Initializes a new instance of the StorageSettings class. Sets the default cache settings.

Declaration

public StorageSettings()

Properties

CacheSettings

Gets or sets the cache settings for storage.

Declaration

public CacheSettings CacheSettings { get; set; }

Property Value

Type	Description
CacheSettings	The configuration settings that define how caching is handled for the report storage.

ItemTypes

Gets or sets the types of storage items.

Declaration

public StorageItemTypes ItemTypes { get; set; }

Property Value

Type	Description
StorageItemTypes	A specification of the types of items that can be stored, such as files, directories, etc.

ParameterId

Gets or sets the parameter identifier.

Declaration

public string ParameterId { get; set; }

Property Value

Type	Description
System.String	A unique string that identifies the parameter associated with the report.

Provider

Gets or sets the storage provider.

Declaration

public StorageProvider Provider { get; set; }

Property Value

Type	Description
StorageProvider	The storage provider instance that handles the data storage operations.

ReportId

Gets or sets the report identifier.

Declaration

public string ReportId { get; set; }

Property Value

Type	Description
System.String	A unique string that serves as the identifier for the report.

ReportModifiedOn

Gets or sets the timestamp of when the report was last modified.

Declaration

public string ReportModifiedOn { get; set; }

Property Value

Type	Description
System.String	A string representation of the last modified timestamp of the report, which helps in tracking changes.

Methods

Delete(String)

Deletes an item from storage by its key.

Declaration

public abstract void Delete(string key)

Parameters

Type	Name	Description
System.String	key	The key of the item to be deleted.

GetBytes(String, String)

Retrieves the bytes of an item from storage by its key and content type.

Declaration

public abstract byte[] GetBytes(string key, string contentType)

Parameters

Type	Name	Description
System.String	key	The key of the item to retrieve.
System.String	contentType	The content type of the item.

Returns

Type	Description
System.Byte[]	The byte array of the item.

IsCacheFileExist(String)

Checks whether a cache file exists for a given cache identifier.

Declaration

public virtual bool IsCacheFileExist(string cacheId)

Parameters

Type	Name	Description
System.String	cacheId	The cache identifier to check.

Returns

Type	Description
System.Boolean	True if the cache file exists; otherwise, false.

SetBytes(String, Byte[], String)

Stores the bytes of an item in storage with a given key and content type.

Declaration

public abstract void SetBytes(string key, byte[] value, string contentType)

Parameters

Type	Name	Description
System.String	key	The key for storing the item.
System.Byte[]	value	The byte array of the item to store.
System.String	contentType	The content type of the item.