Search Results for

    Show / Hide Table of Contents

    Class MetadataStatus

    The overall status of the contents and list items in comparison to the actual schemas' structure

    Inheritance
    object
    MetadataStatus
    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
    [GeneratedCode("NJsonSchema", "13.20.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")]
    public class MetadataStatus

    Properties

    ContentOrLayerSchemaIds

    The schema ids (of type Content or Layer) for which the contents are outdated and need to be updated.

    Declaration
    [JsonProperty("contentOrLayerSchemaIds", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
    [Obsolete("Use MainDocuments.ContentOrLayerSchemaIds instead. This will be removed in version 11.15.")]
    public ICollection<string> ContentOrLayerSchemaIds { get; set; }
    Property Value
    ICollection<string>

    FieldIdsToCleanup

    The field ids that that cannot be used and needs to be cleaned up after updating the outdated contents and list items.

    Declaration
    [JsonProperty("fieldIdsToCleanup", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
    public IDictionary<string, ICollection<string>> FieldIdsToCleanup { get; set; }
    Property Value
    IDictionary<string, ICollection<string>>

    ListSchemaIds

    The schema ids (of type List) for which the the list items are outdated and need to be updated.

    Declaration
    [JsonProperty("listSchemaIds", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
    [Obsolete("Use MainDocuments.ListSchemaIds instead. This will be removed in version 11.15.")]
    public ICollection<string> ListSchemaIds { get; set; }
    Property Value
    ICollection<string>

    MainDocuments

    Schema IDs for which main documents need to be touched.

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

    SearchDocuments

    Schema IDs for which search documents need to be touched.

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

    State

    The global state of the Contents and ListItems compared to the schema structure (Green = ok, Red = update needed).

    Declaration
    [JsonProperty("state", Required = Required.Always)]
    [Required(AllowEmptyStrings = true)]
    [JsonConverter(typeof(StringEnumConverter))]
    public MetadataState State { get; set; }
    Property Value
    MetadataState

    Methods

    FromJson(string)

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

    Returns
    MetadataStatus

    ToJson()

    Declaration
    public string ToJson()
    Returns
    string

    Back to top Generated by DocFX