Class UserRoleSearchRequest

Inheritance
object
UserRoleSearchRequest
Inherited Members
Namespace: System.Dynamic.ExpandoObject
Syntax
[GeneratedCode("NJsonSchema", "13.20.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")]
public class UserRoleSearchRequest

Properties

DebugMode

Enable debug mode to get as result of the Searched additional debug information. Warning! It severely affects performance.

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

Filter

Filter applied to user roles.

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

IncludeAdministratorSystemUserRole

Defines if the user roles with system user role Administrator is returned.

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

IncludeAnonymousUserRole

Defines if anonymous user role should be returned.

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

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

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

SearchBehaviors

An optional list of search behaviors. All the passed behaviors will be applied.

Declaration
[JsonProperty("searchBehaviors", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore, ItemConverterType = typeof(StringEnumConverter))]
public ICollection<SearchBehavior> SearchBehaviors { get; set; }
Property Value
ICollection<SearchBehavior>

SearchLanguages

Which languages to search against when using the search string.

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

SearchString

Limits the search by using a query string filter. The Lucene query string syntax is supported.

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

Sort

Fields and respective directions requested to sort the search results.

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 UserRoleSearchRequest FromJson(string data)
Parameters
string data

Returns
UserRoleSearchRequest

ToJson()

Declaration
public string ToJson()
Returns
string