Search Results for

    Show / Hide Table of Contents

    Class Output

    Output

    Inheritance
    object
    Output
    OutputDetail
    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 class Output

    Properties

    AttemptsLeft

    Number of rendering retry attempts left.

    Declaration
    [JsonProperty("attemptsLeft", Required = Required.Always)]
    public int AttemptsLeft { get; set; }
    Property Value
    int

    AvailabilityState

    Describes whether the output is available normally or if it is outdated. Note that this does not take into account failed or not yet performed rendering or similar.

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

    BackupTimestamp

    Date and time of the backup of the output file.

    Declaration
    [JsonProperty("backupTimestamp", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
    [Obsolete("Backup of outputs is implemented differently now")]
    public DateTime? BackupTimestamp { get; set; }
    Property Value
    DateTime?

    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

    Detail of the output that are format dependent.

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

    DynamicRendering

    Whether this Output belongs to a dynamic OutputFormat.

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

    FileVersion

    Version counter incremented every time this output is rendered (or in case of Original when new original is uploaded).

    Declaration
    [JsonProperty("fileVersion", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
    [Obsolete("Value was less accurate than it might have seemed")]
    public int? FileVersion { get; set; }
    Property Value
    int?

    Id

    The ID of the output. Can be null for dynamic outputs which are not rendered yet.

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

    OutputFormatCategory

    Category of OutputFormat which this output represents.

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

    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 RenderingStateV2")]
    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?

    Methods

    FromJson(string)

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

    Returns
    Output

    ToJson()

    Declaration
    public string ToJson()
    Returns
    string

    Back to top Generated by DocFX