logo
logo
  • Interface IRenditionItem

    Is part of an IRendition.

    Namespace: Stylelabs.M.Sdk.Contracts.Base
    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

    Link to the rendition file.

    Declaration
    Uri Href { get; }
    Property Value
    Type Description
    Uri

    Methods

    DownloadAsync(String, Boolean)

    Downloads the rendition item to a location on disk.

    Declaration
    Task DownloadAsync(string filePath, bool overwrite = false)
    Parameters
    Type Name Description
    System.String filePath

    The location to download the file to.

    System.Boolean overwrite

    If the file is allowed to be overwritten.

    Returns
    Type Description
    Task

    GetStreamAsync()

    Gets a containing the contents of the rendition item.

    Declaration
    Task<Stream> GetStreamAsync()
    Returns
    Type Description
    Task<Stream>

    A containing the contents of the rendition item.

    Can we improve this article ? Provide feedback