文章 LeaderboardListOptions 类

  • 命名空间: Limyee.Extensibility.Api.Version1
  • 程序集: Limyee.Api.dll

定义

class LeaderboardListOptions
{
	Guid? ContainerId { get; set;  }
	string ContentIds { get; set;  }
	string DisplayStatus { get; set;  }
	string NameQuery { get; set;  }
	int? PageIndex { get; set;  }
	int? PageSize { get; set;  }
	Guid? PermissionId { get; set;  }
	string Scope { get; set;  }
	string SortBy { get; set;  }
	string SortOrder { get; set;  }
}

属性

名称

类型

描述

默认值

选项

ContainerId

Guid?

Filter by Container to list group level leaderboards. Optional. If ContainerId is set, Scope is ignored and automatically set to 'Container'.

ContentIds

string

Comma separated list of ContentIds. Used to limit to a specific set of leaderboards as well as sort order if SoryBy is set to ContentIdsOrder. Optional parameter

DisplayStatus

string

Filter by the display status of the leaderboard. Possibel values are (All, Displayed, Future, Past). Optional.

NameQuery

string

Filter by the name of the leaderboard. Optional.

PageIndex

int?

Number of results per page. Optional.

PageSize

int?

Index of page to return. Optional.

PermissionId

Guid?

Used to get a list of leaderboards for which the current user has the provided Permission ID.

Scope

string

Filter by leaderboard location. Optional. Possible values are (All, Global, Container). Ignored if ContainerId is specified.

SortBy

string

Specify sort comparison. Options are: Name (default), CreatedDate, ContentIdsOrder. Optional.

SortOrder

string

Sort order is either Ascending or Descending (by name). Optional.