Search Results for

    Show / Hide Table of Contents

    Class ShareOutputBase

    Base of shared output

    Inheritance
    object
    ShareOutputBase
    ShareOutputBasic
    ShareOutputDisplayContent
    ShareOutputEmbed
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: System.Dynamic.ExpandoObject
    Syntax
    [JsonConverter(typeof(JsonInheritanceConverter), new object[] { "kind" })]
    [GeneratedCode("NJsonSchema", "13.20.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")]
    public abstract class ShareOutputBase

    Properties

    ContentId

    The ID of the content for which this output has been created.

    Declaration
    [JsonProperty("contentId", Required = Required.Always)]
    [Required]
    public string ContentId { get; set; }
    Property Value
    string

    Detail

    Output details.

    Declaration
    [JsonProperty("detail", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
    public OutputDataBase Detail { get; set; }
    Property Value
    OutputDataBase

    DownloadUrl

    Url to directly download output. In case of BasicShare if not fetched using a token, a placeholder {token} is included which needs to be replaced with the recipient's token

    Declaration
    [JsonProperty("downloadUrl", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
    public string DownloadUrl { get; set; }
    Property Value
    string

    DynamicRendering

    Whether this Output belongs to a dynamic OutputFormat.

    Declaration
    [JsonProperty("dynamicRendering", Required = Required.Always)]
    public bool DynamicRendering { get; set; }
    Property Value
    bool

    OutputFormatId

    The ID of the output format this output represents.

    Declaration
    [JsonProperty("outputFormatId", Required = Required.Always)]
    [Required]
    public string OutputFormatId { get; set; }
    Property Value
    string

    RenderingState

    The rendering state of the output file.

    Declaration
    [JsonProperty("renderingState", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
    [JsonConverter(typeof(StringEnumConverter))]
    [Obsolete("Replaced by OutputRenderingStateV2")]
    public OutputRenderingState? RenderingState { get; set; }
    Property Value
    OutputRenderingState?

    RenderingStateV2

    The rendering state of the output file. Only null for static outputs which are not rendered ("Skipped" in old RenderingState), such outputs won't be returned in the future.

    Declaration
    [JsonProperty("renderingStateV2", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
    [JsonConverter(typeof(StringEnumConverter))]
    public OutputRenderingStateV2? RenderingStateV2 { get; set; }
    Property Value
    OutputRenderingStateV2?

    ViewUrl

    Url to directly view output. In case of BasicShare if not fetched using a token, a placeholder {token} is included which needs to be replaced with the recipient's token

    Declaration
    [JsonProperty("viewUrl", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
    public string ViewUrl { get; set; }
    Property Value
    string

    Methods

    FromJson(string)

    Declaration
    public static ShareOutputBase FromJson(string data)
    Parameters
    string data

    Returns
    ShareOutputBase

    ToJson()

    Declaration
    public string ToJson()
    Returns
    string

    Back to top Generated by DocFX