Class BaseSearchArgs<T>

Base class for supporting other SearchRequest class with pagination information

Inheritance

object

BaseSearchArgs<T>

GetContentVersionsArgs

GetContentsArgs

GetPlayerContentsArgs

GetRepresentationVersionsArgs

GetRepresentationsArgs

GetSubscriptionsArgs

SearchContentModerationArgs

SearchRepresentationsArgs

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Unity.Services.Ugc.Bridge

Assembly: Unity.Services.Ugc.Bridge.Editor.dll

Syntax

public class BaseSearchArgs<T> where T : struct, Enum

Type Parameters

Name	Description
T	Enum of the fields that can be sorted for that request

Properties

Filters

Optional list of filters

Declaration

public List<string> Filters { get; set; }

Property Value

Type	Description
List<string>

IncludeTotal

Optional flag to includes the total in the search result

Declaration

public bool IncludeTotal { get; set; }

Property Value

Type	Description
bool

Limit

Optional maximum number of results that will be retrieved

Declaration

public int Limit { get; set; }

Property Value

Type	Description
int

Offset

Optional results offset used for pagination

Declaration

public int Offset { get; set; }

Property Value

Type	Description
int

Search

Optional search term used to retrieve specific results

Declaration

public string Search { get; set; }

Property Value

Type	Description
string

Methods

AddSortBy(T, bool)

Add a new sort rule to the request. Sorts will be done in the order of which they were added.

Declaration

public void AddSortBy(T sortBy, bool isDescending)

Parameters

Type	Name	Description
T	sortBy	The field by which the request should be sorted.
bool	isDescending	Set to true if the sort should be descending, false otherwise