Search Results for

    Show / Hide Table of Contents

    Class ChannelUpdateRequest

    Inheritance
    object
    ChannelUpdateRequest
    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 ChannelUpdateRequest

    Properties

    Aggregations

    An optional list of aggregators. These aggregations are added by default on each aggregation requests.

    Declaration
    [JsonProperty("aggregations", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
    public ICollection<AggregatorBase> Aggregations { get; set; }
    Property Value
    ICollection<AggregatorBase>

    ExtendedSimpleSearchFields

    An Optional list of fields. These fields extend the list of simple search fields outside the bounds of any schema field configuration.

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

    Filter

    An optional search filter. Limits the content document result set on each search and aggregation request.

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

    GrantedUserRoleIds

    User roles granted access to the channel.

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

    MissingResultsDisplayPatterns

    Display pattern to use for rendering details when 0 results are returned

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

    Names

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

    SearchIndexId

    Language specific names.

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

    Sort

    Default sort order specified for the channel to sort the results of a content search.

    Declaration
    [JsonProperty("sort", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
    public ICollection<SortInfo> Sort { get; set; }
    Property Value
    ICollection<SortInfo>

    SortFields

    Fields to be used for sorting in content browser when displaying the channel. The information is only set and consumed by the client, not by the server.

    Declaration
    [JsonProperty("sortFields", Required = Required.Always)]
    [Required]
    public ICollection<SortField> SortFields { get; set; }
    Property Value
    ICollection<SortField>

    SortOrder

    Order in which the channels should be displayed.

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

    ViewForAll

    Grants rights to all the users to view the channel.

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

    Methods

    FromJson(string)

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

    Returns
    ChannelUpdateRequest

    ToJson()

    Declaration
    public string ToJson()
    Returns
    string

    Back to top Generated by DocFX