1. Stylelabs.M.Sdk.Contracts.Base

Interface IRenditionItem

Is part of an IRendition.

Namespace: StylelabsStylelabs.MSdkStylelabs.M.Sdk.ContractsBase

Assembly: Stylelabs.M.Sdk.dll

Syntax

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

Uri Href { get; }

Property Value

TypeDescription
Uri

Methods

DownloadAsync(string, bool)

Downloads the rendition item to a location on disk.

Declaration

Task DownloadAsync(string filePath, bool overwrite = false)

Parameters

TypeNameDescription
stringfilePathThe location to download the file to.
booloverwriteIf the file is allowed to be overwritten.

Returns

TypeDescription
TaskAn awaitable .

GetStreamAsync()

Gets a containing the contents of the rendition item.

Declaration

Task<Stream> GetStreamAsync()

Returns

TypeDescription
Task<>StreamA containing the contents of the rendition item.
If you have suggestions for improving this article, let us know!