Class RenditionItemBase

Current version: 4.0

Base class for rendition items.

Inheritance
object
RenditionItemBase
Implements
Namespace: StylelabsStylelabs.MSdkStylelabs.M.Sdk.ModelsBase
Assembly: Stylelabs.M.Sdk.dll
Syntax
RequestResponse
public abstract class RenditionItemBase : IRenditionItem

Properties

Href

Gets link to the rendition file.

Declaration
RequestResponse
public Uri Href { get; protected set; }
Property Value
TypeDescription
Uri

Methods

DownloadAsync(string, bool)

Downloads the rendition item to a location on disk.

Declaration
RequestResponse
public 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
public abstract Task<Stream> GetStreamAsync()
Returns
TypeDescription
Task<>Stream

A containing the contents of the rendition item.

Implements

Do you have some feedback for us?

If you have suggestions for improving this article,