Search Results for

    Show / Hide Table of Contents

    Class OutputFormatEditable

    Represents the editable part of the output format.

    Inheritance
    object
    OutputFormatRenderingSpecification
    OutputFormatEditable
    OutputFormat
    OutputFormatUpdateManyRequestItem
    Inherited Members
    OutputFormatRenderingSpecification.SourceOutputFormats
    OutputFormatRenderingSpecification.Format
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: System.Dynamic.ExpandoObject
    Syntax
    [GeneratedCode("NJsonSchema", "13.20.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")]
    public class OutputFormatEditable : OutputFormatRenderingSpecification

    Properties

    Behaviors

    Defines how the OutputFormat should behave for certain features (Download, Sharing, Media editing).

    Declaration
    [JsonProperty("behaviors", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
    public OutputFormatBehaviors Behaviors { get; set; }
    Property Value
    OutputFormatBehaviors

    DownloadFileNamePatterns

    Optional patterns (liquid syntax) that produce the filename for item of this output format.
    If set, the customer's default language is required.

    Declaration
    [JsonProperty("downloadFileNamePatterns", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
    public TranslatedStringDictionary DownloadFileNamePatterns { get; set; }
    Property Value
    TranslatedStringDictionary

    EnableXmpWriteback

    Indicates if metadata should be written into XMP header of outputs where applicable and configured.

    Declaration
    [JsonProperty("enableXmpWriteback", Required = Required.DisallowNull, NullValueHandling = NullValueHandling.Ignore)]
    public bool EnableXmpWriteback { get; set; }
    Property Value
    bool

    Names

    Language specific names.

    Declaration
    [JsonProperty("names", Required = Required.Always)]
    [Required]
    public TranslatedStringDictionary Names { get; set; }
    Property Value
    TranslatedStringDictionary

    RetentionTime

    How long should the dynamic outputs created from this format be kept.

    Declaration
    [JsonProperty("retentionTime", Required = Required.DisallowNull, NullValueHandling = NullValueHandling.Ignore)]
    public TimeSpan RetentionTime { get; set; }
    Property Value
    TimeSpan

    ViewForAll

    Indicates if outputs of this format should be accessible for users not having AccessOriginal permission on the content.

    Declaration
    [JsonProperty("viewForAll", Required = Required.DisallowNull, NullValueHandling = NullValueHandling.Ignore)]
    public bool ViewForAll { get; set; }
    Property Value
    bool

    XmpWritebackOptions

    Defines additional settings for XmpWriteback

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

    Methods

    FromJson(string)

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

    Returns
    OutputFormatEditable

    ToJson()

    Declaration
    public string ToJson()
    Returns
    string

    Back to top Generated by DocFX