Class RenditionItemBase
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 : IRenditionItemProperties
Href
Gets link to the rendition file.
Declaration
RequestResponse
public Uri Href { get; protected set; }Property Value
| Type | Description |
|---|---|
| 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
| Type | Name | Description |
|---|---|---|
| string | filePath |
The location to download the file to. |
| bool | overwrite |
If the file is allowed to be overwritten. |
Returns
| Type | Description |
|---|---|
| Task |
An awaitable . |
GetStreamAsync()
Gets a containing the contents of the rendition item.
Declaration
RequestResponse
public abstract Task<Stream> GetStreamAsync()Returns
| Type | Description |
|---|---|
| Task<>Stream |
A containing the contents of the rendition item. |