Search Results for

    Show / Hide Table of Contents

    Class UserListRequest

    Represents user list request.

    Inheritance
    object
    UsersSearchBaseRequest
    UserListRequest
    Inherited Members
    UsersSearchBaseRequest.SearchString
    UsersSearchBaseRequest.SearchBehaviors
    UsersSearchBaseRequest.Filter
    UsersSearchBaseRequest.LifeCycleFilter
    UsersSearchBaseRequest.UserRightsFilter
    UsersSearchBaseRequest.IncludeServiceUser
    UsersSearchBaseRequest.IncludeAnonymousUser
    UsersSearchBaseRequest.EditableOnly
    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 UserListRequest : UsersSearchBaseRequest

    Properties

    Limit

    Limits the document count of the result set.

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

    PageToken

    The token used to retrieve the next page of results. It must be null on first request and only filled with the returned pageToken to request next page of results.

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

    Sort

    Fields and respective directions requested to sort the search results. Sorting on a not indexed field will throw an exception.

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

    Methods

    FromJson(string)

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

    Returns
    UserListRequest

    ToJson()

    Declaration
    public string ToJson()
    Returns
    string

    Back to top Generated by DocFX