Interface IRenditionItem

Is part of an IRendition.

Namespace: StylelabsStylelabs.MSdkStylelabs.M.Sdk.ContractsBase
Assembly: Stylelabs.M.Sdk.dll
Syntax
RequestResponse

public interface IRenditionItem
Remarks

Depending on the file type, there can be one or more rendition items. For example a PDF will have an item per page.

Properties

Href

Gets link to the rendition file.

Declaration
RequestResponse

Uri Href { get; }
Property Value
TypeDescription
Uri

Methods

DownloadAsync(string, bool)

Downloads the rendition item to a location on disk.

Declaration
RequestResponse

Task DownloadAsync(string filePath, bool overwrite = false)
Parameters
TypeNameDescription
stringfilePath

The location to download the file to.

booloverwrite

If the file is allowed to be overwritten.

Returns
TypeDescription
Task

An awaitable .

GetStreamAsync()

Gets a containing the contents of the rendition item.

Declaration
RequestResponse

Task<Stream> GetStreamAsync()
Returns
TypeDescription
Task<>Stream

A containing the contents of the rendition item.

Do you have some feedback for us?

If you have suggestions for improving this article,