程序包 cn.leancloud

类 LCLeaderboard

  • public class LCLeaderboard
extends java.lang.Object

    • 字段详细资料

      • INVALID_VERSION

        public static final int INVALID_VERSION
        另请参阅:
        常量字段值

      • MEMBER_TYPE_USER

        public static final java.lang.String MEMBER_TYPE_USER
        另请参阅:
        常量字段值

      • MEMBER_TYPE_ENTITY

        public static final java.lang.String MEMBER_TYPE_ENTITY
        另请参阅:
        常量字段值

      • MEMBER_TYPE_OBJECT

        public static final java.lang.String MEMBER_TYPE_OBJECT
        另请参阅:
        常量字段值

    • 构造器详细资料

      • LCLeaderboard

        protected LCLeaderboard​(LCObject object)

    • 方法详细资料

      • getStatisticName

        public java.lang.String getStatisticName()
        get statistic name
        返回:
        statistic name

      • getVersion

        public int getVersion()
        get version
        返回:
        version number

      • getNextResetAt

        public java.util.Date getNextResetAt()
        get next reset timestamp
        返回:
        next reset timestamp

      • getCreatedAt

        public java.util.Date getCreatedAt()
        get create timestamp
        返回:
        create timestamp

      • setVersion

        public void setVersion​(int version)

      • lookup

        protected static <T extends java.lang.Enum<T>> T lookup​(java.lang.Class<T> enumType,
                                                        java.lang.String name)

      • createWithoutData

        public static LCLeaderboard createWithoutData​(java.lang.String name)
        create instance with leaderboard name
        参数:
        name - leaderboard name
        返回:
        instance

      • createWithoutData

        public static LCLeaderboard createWithoutData​(java.lang.String name,
                                              java.lang.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,
                                                                         java.util.Map<java.lang.String,​java.lang.Double> values)
        update user's statistic
        参数:
        user - user instance
        values - statistics
        返回:
        observable instance.

      • updateStatistic

        public static io.reactivex.Observable<LCStatisticResult> updateStatistic​(LCUser user,
                                                                         java.util.Map<java.lang.String,​java.lang.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,
                                                                           java.util.List<java.lang.String> statisticNames)
        get user's statistics
        参数:
        user - user instance
        statisticNames - statistic names
        返回:
        observable instance.

      • getMemberStatistics

        public static io.reactivex.Observable<LCStatisticResult> getMemberStatistics​(java.lang.String memberType,
                                                                             java.lang.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​(java.lang.String memberType,
                                                                             java.lang.String memberId,
                                                                             java.util.List<java.lang.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.

      • queryGroupStatistics

        public static io.reactivex.Observable<LCStatisticResult> queryGroupStatistics​(java.lang.String memberType,
                                                                              java.lang.String statisticName,
                                                                              java.util.List<java.lang.String> targetKeys)
        query a group of users/objects/entities statistic results.
        参数:
        memberType - member type. MEMBER_TYPE_USER("_User"): leaderboard target is LCUser MEMBER_TYPE_ENTITY("_Entity"): leaderboard target is any entity MEMBER_TYPE_ENTITY("_Object"): leaderboard target is LCObject
        statisticName - statistic names.
        targetKeys - target ids.
        返回:
        observable instance.

      • getResults

        public io.reactivex.Observable<LCLeaderboardResult> getResults​(int skip,
                                                               int limit,
                                                               java.util.List<java.lang.String> selectMemberKeys,
                                                               java.util.List<java.lang.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,
                                                               java.util.List<java.lang.String> selectMemberKeys,
                                                               java.util.List<java.lang.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.

      • getGroupResults

        public io.reactivex.Observable<LCLeaderboardResult> getGroupResults​(java.util.List<java.lang.String> groupUserIds,
                                                                    int skip,
                                                                    int limit,
                                                                    java.util.List<java.lang.String> selectMemberKeys,
                                                                    java.util.List<java.lang.String> includeStatistics)
        get group user's ranking.
        参数:
        groupUserIds - user id list.
        skip - skip number.
        limit - max result limitation.
        selectMemberKeys - select member(user) keys(optional)
        includeStatistics - include other statistics(optional)
        返回:
        observable instance.

      • getAroundResults

        public io.reactivex.Observable<LCLeaderboardResult> getAroundResults​(java.lang.String targetId,
                                                                     int skip,
                                                                     int limit,
                                                                     java.util.List<java.lang.String> selectMemberKeys,
                                                                     java.util.List<java.lang.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.

      • getAroundInGroupResults

        public io.reactivex.Observable<LCLeaderboardResult> getAroundInGroupResults​(java.util.List<java.lang.String> groupUserIds,
                                                                            java.lang.String targetId,
                                                                            int limit,
                                                                            java.util.List<java.lang.String> selectMemberKeys,
                                                                            java.util.List<java.lang.String> includeStatistics)
        get leaderboard results around target id within specified group.
        参数:
        groupUserIds - user id list.
        targetId - target user id.
        limit - query limit.
        selectMemberKeys - select object keys(optional)
        includeStatistics - include other statistics(optional)
        返回:
        observable instance.

      • queryGroupStatistics

        public io.reactivex.Observable<LCStatisticResult> queryGroupStatistics​(java.util.List<java.lang.String> targetKeys)
        query multiple users/objects/entities statistic results.
        参数:
        targetKeys - target id list.
        返回:
        observable instance.

      • fetchByName

        public static io.reactivex.Observable<LCLeaderboard> fetchByName​(java.lang.String name)
        fetch leaderboard with name
        参数:
        name - leaderboard name
        返回:
        leaderboard observer.

      • reset

        public io.reactivex.Observable<java.lang.Boolean> reset()
        reset current leaderboard.
        返回:
        boolean observer that always emits true.

      • updateVersionChangeInterval

        public io.reactivex.Observable<java.lang.Boolean> updateVersionChangeInterval​(LCLeaderboard.LCLeaderboardVersionChangeInterval interval)
        update current leaderboard's change interval
        参数:
        interval - new change interval
        返回:
        boolean observer that always emits true.

      • updateUpdateStrategy

        public io.reactivex.Observable<java.lang.Boolean> updateUpdateStrategy​(LCLeaderboard.LCLeaderboardUpdateStrategy strategy)
        update current leaderboard's update strategy.
        参数:
        strategy - new update strategy.
        返回:
        boolean observer that always emits true.

      • destroy

        public io.reactivex.Observable<java.lang.Boolean> destroy()
        destroy current leaderboard.
        返回:
        boolean observer that always emits true.