cn.leancloud

类 LCLeaderboard

java.lang.Object

cn.leancloud.LCLeaderboard

public class LCLeaderboard
extends Object

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	LCLeaderboard.LCLeaderboardOrder
static class	LCLeaderboard.LCLeaderboardUpdateStrategy
static class	LCLeaderboard.LCLeaderboardVersionChangeInterval

字段概要

字段

限定符和类型	字段和说明
static int	INVALID_VERSION
static String	MEMBER_TYPE_ENTITY
static String	MEMBER_TYPE_USER

构造器概要

构造器

限定符	构造器和说明
protected	LCLeaderboard(LCObject object)

方法概要

限定符和类型	方法和说明
static io.reactivex.Observable<LCLeaderboard>	create(String name, LCLeaderboard.LCLeaderboardOrder order, LCLeaderboard.LCLeaderboardUpdateStrategy updateStrategy, LCLeaderboard.LCLeaderboardVersionChangeInterval versionChangeInterval) create leaderboard with default member type(User).
static io.reactivex.Observable<LCLeaderboard>	createWithMemberType(String memberType, String name, LCLeaderboard.LCLeaderboardOrder order, LCLeaderboard.LCLeaderboardUpdateStrategy updateStrategy, LCLeaderboard.LCLeaderboardVersionChangeInterval versionChangeInterval) create leaderboard with customized member type
static LCLeaderboard	createWithoutData(String name) create instance with leaderboard name
static LCLeaderboard	createWithoutData(String name, String memberType) create instance with leaderboard name and type.
io.reactivex.Observable<Boolean>	destroy() destroy current leaderboard.
static io.reactivex.Observable<LCLeaderboard>	fetchByName(String name) fetch leaderboard with name
io.reactivex.Observable<LCLeaderboardResult>	getAroundResults(String targetId, int skip, int limit, List<String> selectMemberKeys, List<String> includeStatistics) get leaderboard results around target id(user, object or entity).
Date	getCreatedAt() get create timestamp
static io.reactivex.Observable<LCStatisticResult>	getMemberStatistics(String memberType, String memberId) get member statistics.
static io.reactivex.Observable<LCStatisticResult>	getMemberStatistics(String memberType, String memberId, List<String> statisticNames) get member statistics
Date	getNextResetAt() get next reset timestamp
LCLeaderboard.LCLeaderboardOrder	getOrder() get leaderboard order
io.reactivex.Observable<LCLeaderboardResult>	getResults(int skip, int limit, List<String> selectMemberKeys, List<String> includeStatistics) get leaderboard results.
io.reactivex.Observable<LCLeaderboardResult>	getResults(int skip, int limit, List<String> selectMemberKeys, List<String> includeStatistics, boolean withCount) get leaderboard results.
String	getStatisticName() get statistic name
LCLeaderboard.LCLeaderboardUpdateStrategy	getUpdateStrategy() get leaderboard update strategy
static io.reactivex.Observable<LCStatisticResult>	getUserStatistics(LCUser user) get user's statistics
static io.reactivex.Observable<LCStatisticResult>	getUserStatistics(LCUser user, List<String> statisticNames) get user's statistics
int	getVersion() get version
LCLeaderboard.LCLeaderboardVersionChangeInterval	getVersionChangeInterval() get version change interval
protected static <T extends Enum<T>> T	lookup(Class<T> enumType, String name)
io.reactivex.Observable<Boolean>	reset() reset current leaderboard.
void	setVersion(int version)
static io.reactivex.Observable<LCStatisticResult>	updateStatistic(LCUser user, Map<String,Double> values) update user's statistic
static io.reactivex.Observable<LCStatisticResult>	updateStatistic(LCUser user, Map<String,Double> params, boolean overwrite) update user's statistic
io.reactivex.Observable<Boolean>	updateUpdateStrategy(LCLeaderboard.LCLeaderboardUpdateStrategy strategy) update current leaderboard's update strategy.
io.reactivex.Observable<Boolean>	updateVersionChangeInterval(LCLeaderboard.LCLeaderboardVersionChangeInterval interval) update current leaderboard's change interval

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

INVALID_VERSION

public static int INVALID_VERSION

MEMBER_TYPE_USER

public static final String MEMBER_TYPE_USER

另请参阅:

常量字段值

MEMBER_TYPE_ENTITY

public static final String MEMBER_TYPE_ENTITY

另请参阅:

常量字段值

构造器详细资料

LCLeaderboard

protected LCLeaderboard(LCObject object)

方法详细资料

getStatisticName

public String getStatisticName()

get statistic name

返回:

statistic name

getOrder

public LCLeaderboard.LCLeaderboardOrder getOrder()

get leaderboard order

返回:

leaderboard order

getUpdateStrategy

public LCLeaderboard.LCLeaderboardUpdateStrategy getUpdateStrategy()

get leaderboard update strategy

返回:

update strategy

getVersionChangeInterval

public LCLeaderboard.LCLeaderboardVersionChangeInterval getVersionChangeInterval()

get version change interval

返回:

version change interval

getVersion

public int getVersion()

get version

返回:

version number

getNextResetAt

public Date getNextResetAt()

get next reset timestamp

返回:

next reset timestamp

getCreatedAt

public Date getCreatedAt()

get create timestamp

返回:

create timestamp

setVersion

public void setVersion(int version)

lookup

protected static <T extends Enum<T>> T lookup(Class<T> enumType,
                                              String name)

createWithoutData

public static LCLeaderboard createWithoutData(String name)

create instance with leaderboard name

参数:

name - leaderboard name

返回:

instance

createWithoutData

public static LCLeaderboard createWithoutData(String name,
                                              String memberType)

create instance with leaderboard name and type.

参数:

name - leaderboard name

memberType - leaderboard member type: MEMBER_TYPE_USER("_User"): leaderboard target is LCUser MEMBER_TYPE_ENTITY("_Entity"): leaderboard target is any entity LCObject Name: leaderboard target is LCObject

返回:

updateStatistic

public static io.reactivex.Observable<LCStatisticResult> updateStatistic(LCUser user,
                                                                         Map<String,Double> values)

update user's statistic

参数:

user - user instance

values - statistics

返回:

observable instance.

updateStatistic

public static io.reactivex.Observable<LCStatisticResult> updateStatistic(LCUser user,
                                                                         Map<String,Double> params,
                                                                         boolean overwrite)

update user's statistic

参数:

user - user instance

params - statistics

overwrite - overwrite flag

返回:

observable instance.

getUserStatistics

public static io.reactivex.Observable<LCStatisticResult> getUserStatistics(LCUser user)

get user's statistics

参数:

user - user instance

返回:

observable instance.

getUserStatistics

public static io.reactivex.Observable<LCStatisticResult> getUserStatistics(LCUser user,
                                                                           List<String> statisticNames)

get user's statistics

参数:

user - user instance

statisticNames - statistic names

返回:

observable instance.

getMemberStatistics

public static io.reactivex.Observable<LCStatisticResult> getMemberStatistics(String memberType,
                                                                             String memberId)

get member statistics.

参数:

memberType - member type MEMBER_TYPE_USER("_User"): leaderboard target is LCUser MEMBER_TYPE_ENTITY("_Entity"): leaderboard target is any entity LCObject Name: leaderboard target is LCObject

memberId - member objectId

返回:

observable instance.

getMemberStatistics

public static io.reactivex.Observable<LCStatisticResult> getMemberStatistics(String memberType,
                                                                             String memberId,
                                                                             List<String> statisticNames)

get member statistics

参数:

memberType - member type MEMBER_TYPE_USER("_User"): leaderboard target is LCUser MEMBER_TYPE_ENTITY("_Entity"): leaderboard target is any entity LCObject Name: leaderboard target is LCObject

memberId - member objectId

statisticNames - statistic names

返回:

observable instance.

getResults

public io.reactivex.Observable<LCLeaderboardResult> getResults(int skip,
                                                               int limit,
                                                               List<String> selectMemberKeys,
                                                               List<String> includeStatistics)

get leaderboard results.

参数:

skip - query offset

limit - query limit

selectMemberKeys - select member(user or object) keys(optional)

includeStatistics - include other statistics(optional)

返回:

observable instance.

getResults

public io.reactivex.Observable<LCLeaderboardResult> getResults(int skip,
                                                               int limit,
                                                               List<String> selectMemberKeys,
                                                               List<String> includeStatistics,
                                                               boolean withCount)

get leaderboard results.

参数:

skip - query offset

limit - query limit

selectMemberKeys - select member(user or object) keys(optional)

includeStatistics - include other statistics(optional)

withCount - need count flag(optional)

返回:

observable instance.

getAroundResults

public io.reactivex.Observable<LCLeaderboardResult> getAroundResults(String targetId,
                                                                     int skip,
                                                                     int limit,
                                                                     List<String> selectMemberKeys,
                                                                     List<String> includeStatistics)

get leaderboard results around target id(user, object or entity).

参数:

targetId - target objectId

skip - query offset

limit - query limit

selectMemberKeys - select object keys(optional)

includeStatistics - include other statistics(optional)

返回:

observable instance.

create

public static io.reactivex.Observable<LCLeaderboard> create(String name,
                                                            LCLeaderboard.LCLeaderboardOrder order,
                                                            LCLeaderboard.LCLeaderboardUpdateStrategy updateStrategy,
                                                            LCLeaderboard.LCLeaderboardVersionChangeInterval versionChangeInterval)

create leaderboard with default member type(User).

参数:

name - name

order - order

updateStrategy - update strategy.

versionChangeInterval - version change interval.

返回:

leaderboard observer.

createWithMemberType

public static io.reactivex.Observable<LCLeaderboard> createWithMemberType(String memberType,
                                                                          String name,
                                                                          LCLeaderboard.LCLeaderboardOrder order,
                                                                          LCLeaderboard.LCLeaderboardUpdateStrategy updateStrategy,
                                                                          LCLeaderboard.LCLeaderboardVersionChangeInterval versionChangeInterval)

create leaderboard with customized member type

参数:

memberType - member type

name - name

order - order

updateStrategy - update strategy.

versionChangeInterval - version change interval.

返回:

leaderboard observer.

fetchByName

public static io.reactivex.Observable<LCLeaderboard> fetchByName(String name)

fetch leaderboard with name

参数:

name - leaderboard name

返回:

leaderboard observer.

reset

public io.reactivex.Observable<Boolean> reset()

reset current leaderboard.

返回:

true or false observer.

updateVersionChangeInterval

public io.reactivex.Observable<Boolean> updateVersionChangeInterval(LCLeaderboard.LCLeaderboardVersionChangeInterval interval)

update current leaderboard's change interval

参数:

interval - new change interval

返回:

true or false observer.

updateUpdateStrategy

public io.reactivex.Observable<Boolean> updateUpdateStrategy(LCLeaderboard.LCLeaderboardUpdateStrategy strategy)

update current leaderboard's update strategy.

参数:

strategy - new update strategy.

返回:

true or false observer.

destroy

public io.reactivex.Observable<Boolean> destroy()

destroy current leaderboard.

返回:

true or false observer.