Search Results for

    Show / Hide Table of Contents

    Class LiveStreamSearchRequest

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

    Properties

    Filter

    An optional search filter. Limits the document result set.

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

    From

    Sets the start date and time for results based on Timestamp attribute.

    Declaration
    [JsonProperty("from", Required = Required.Always)]
    [Required(AllowEmptyStrings = true)]
    public DateTime From { get; set; }
    Property Value
    DateTime

    Limit

    Limits the document count of the result set. Defaults to 30.

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

    PageToken

    To get a large amount of data, page token returned from the response can be used to get all data.

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

    ScopeType

    Optionally limits the result to only the specified scope type.

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

    To

    Sets the end date and time for results based on Timestamp attribute.

    Declaration
    [JsonProperty("to", Required = Required.Always)]
    [Required(AllowEmptyStrings = true)]
    public DateTime To { get; set; }
    Property Value
    DateTime

    Methods

    FromJson(string)

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

    Returns
    LiveStreamSearchRequest

    ToJson()

    Declaration
    public string ToJson()
    Returns
    string

    Back to top Generated by DocFX