Package apple.gamekit

Class GKLeaderboard

  • All Implemented Interfaces:
    NSObject

    public class GKLeaderboard
    extends NSObject
    GKLeaderboard represents a single instance of a leaderboard for the current game. Leaderboards can be of the following types: 1. Classic - Traditional, non-expiring leaderboards 2. Recurring - Periodic timed leaderboards that follow a recurrence rule defined in App Store Connect.
    • Constructor Detail

      • GKLeaderboard

        protected GKLeaderboard​(org.moe.natj.general.Pointer peer)
    • Method Detail

      • accessInstanceVariablesDirectly

        public static boolean accessInstanceVariablesDirectly()
      • allocWithZone

        public static GKLeaderboard allocWithZone​(org.moe.natj.general.ptr.VoidPtr zone)
      • automaticallyNotifiesObserversForKey

        public static boolean automaticallyNotifiesObserversForKey​(@NotNull
                                                                   @NotNull java.lang.String key)
      • cancelPreviousPerformRequestsWithTarget

        public static void cancelPreviousPerformRequestsWithTarget​(@NotNull
                                                                   @NotNull java.lang.Object aTarget)
      • cancelPreviousPerformRequestsWithTargetSelectorObject

        public static void cancelPreviousPerformRequestsWithTargetSelectorObject​(@NotNull
                                                                                 @NotNull java.lang.Object aTarget,
                                                                                 @NotNull
                                                                                 @NotNull org.moe.natj.objc.SEL aSelector,
                                                                                 @Nullable
                                                                                 @Nullable java.lang.Object anArgument)
      • classFallbacksForKeyedArchiver

        @NotNull
        public static @NotNull NSArray<java.lang.String> classFallbacksForKeyedArchiver()
      • classForKeyedUnarchiver

        @NotNull
        public static @NotNull org.moe.natj.objc.Class classForKeyedUnarchiver()
      • debugDescription_static

        public static java.lang.String debugDescription_static()
      • description_static

        public static java.lang.String description_static()
      • hash_static

        public static long hash_static()
      • instanceMethodSignatureForSelector

        public static NSMethodSignature instanceMethodSignatureForSelector​(org.moe.natj.objc.SEL aSelector)
      • instancesRespondToSelector

        public static boolean instancesRespondToSelector​(org.moe.natj.objc.SEL aSelector)
      • isSubclassOfClass

        public static boolean isSubclassOfClass​(org.moe.natj.objc.Class aClass)
      • keyPathsForValuesAffectingValueForKey

        @NotNull
        public static @NotNull NSSet<java.lang.String> keyPathsForValuesAffectingValueForKey​(@NotNull
                                                                                             @NotNull java.lang.String key)
      • loadLeaderboardsWithCompletionHandler

        @Deprecated
        public static void loadLeaderboardsWithCompletionHandler​(@Nullable
                                                                 @Nullable GKLeaderboard.Block_loadLeaderboardsWithCompletionHandler completionHandler)
        Deprecated.
        Loads the array of GKLeaderboard for your app Possible reasons for error: 1. Communications problem 2. Unauthenticated player 3. Leaderboard not present API-Since: 6.0 Deprecated-Since: 14.0
      • resolveClassMethod

        public static boolean resolveClassMethod​(org.moe.natj.objc.SEL sel)
      • resolveInstanceMethod

        public static boolean resolveInstanceMethod​(org.moe.natj.objc.SEL sel)
      • setDefaultLeaderboardWithCompletionHandler

        @Deprecated
        public static void setDefaultLeaderboardWithCompletionHandler​(@Nullable
                                                                      @Nullable java.lang.String leaderboardIdentifier,
                                                                      @Nullable
                                                                      @Nullable GKLeaderboard.Block_setDefaultLeaderboardWithCompletionHandler completionHandler)
        Deprecated.
        API-Since: 5.0 Deprecated-Since: 7.0
      • setVersion_static

        public static void setVersion_static​(long aVersion)
      • superclass_static

        public static org.moe.natj.objc.Class superclass_static()
      • version_static

        public static long version_static()
      • category

        @Nullable
        @Deprecated
        public @Nullable java.lang.String category()
        Deprecated.
        API-Since: 4.1 Deprecated-Since: 7.0
      • groupIdentifier

        @Nullable
        public @Nullable java.lang.String groupIdentifier()
        set when leaderboards have been designated a game group; set when loadLeaderboardsWithCompletionHandler has been called for leaderboards that support game groups API-Since: 6.0
      • identifier

        @Nullable
        @Deprecated
        public @Nullable java.lang.String identifier()
        Deprecated.
        leaderboardID. If nil, fetch the aggregate leaderboard. API-Since: 7.0 Deprecated-Since: 14.0
      • init

        @Deprecated
        public GKLeaderboard init()
        Deprecated.
        Default is the range 1-10 with Global/AllTime scopes. If you want to change the scopes or range, set the properites before loading the scores. API-Since: 4.0 Deprecated-Since: 14.0
        Overrides:
        init in class NSObject
      • initWithPlayerIDs

        @Deprecated
        public GKLeaderboard initWithPlayerIDs​(@Nullable
                                               @Nullable NSArray<java.lang.String> playerIDs)
        Deprecated.
        API-Since: 4.1 Deprecated-Since: 8.0
      • initWithPlayers

        @Deprecated
        public GKLeaderboard initWithPlayers​(@NotNull
                                             @NotNull NSArray<? extends GKPlayer> players)
        Deprecated.
        Specify an array of GKPlayers. For example, the players who are in a match together Defaults to AllTime score, if you want to change the timeScope, set the property before loading the scores. Range and playerScope are not applicable. players may not be nil. API-Since: 8.0 Deprecated-Since: 14.0
      • isLoading

        @Deprecated
        public boolean isLoading()
        Deprecated.
        This property is true if the leaderboard is currently loading API-Since: 4.1 Deprecated-Since: 14.0
      • loadScoresWithCompletionHandler

        @Deprecated
        public void loadScoresWithCompletionHandler​(@Nullable
                                                    @Nullable GKLeaderboard.Block_loadScoresWithCompletionHandler completionHandler)
        Deprecated.
        Load the scores for this leader board asynchronously. Error will be nil on success. Possible reasons for error: 1. Communications problem 2. Unauthenticated player API-Since: 4.0 Deprecated-Since: 14.0
      • localPlayerScore

        @Nullable
        @Deprecated
        public @Nullable GKScore localPlayerScore()
        Deprecated.
        The local player's score API-Since: 4.0 Deprecated-Since: 14.0
      • maxRange

        @Deprecated
        public long maxRange()
        Deprecated.
        The maxRange which represents the size of the leaderboard is not valid until loadScores: has completed. API-Since: 4.0 Deprecated-Since: 14.0
      • playerScope

        @Deprecated
        public long playerScope()
        Deprecated.
        Filter on friends. Does not apply to leaderboard initialized with players. API-Since: 4.0 Deprecated-Since: 14.0
      • range

        @Deprecated
        public NSRange range()
        Deprecated.
        Leaderboards start at index 1 and the length should be less than 100. Does not apply to leaderboards initialized with players. Exception will be thrown if developer tries to set an invalid range. API-Since: 4.0 Deprecated-Since: 14.0
      • scores

        @Nullable
        @Deprecated
        public @Nullable NSArray<? extends GKScore> scores()
        Deprecated.
        Scores are not valid until loadScores: has completed. API-Since: 4.0 Deprecated-Since: 14.0
      • setCategory

        @Deprecated
        public void setCategory​(@Nullable
                                @Nullable java.lang.String value)
        Deprecated.
        API-Since: 4.1 Deprecated-Since: 7.0
      • setIdentifier

        @Deprecated
        public void setIdentifier​(@Nullable
                                  @Nullable java.lang.String value)
        Deprecated.
        leaderboardID. If nil, fetch the aggregate leaderboard. API-Since: 7.0 Deprecated-Since: 14.0
      • setPlayerScope

        @Deprecated
        public void setPlayerScope​(long value)
        Deprecated.
        Filter on friends. Does not apply to leaderboard initialized with players. API-Since: 4.0 Deprecated-Since: 14.0
      • setRange

        @Deprecated
        public void setRange​(NSRange value)
        Deprecated.
        Leaderboards start at index 1 and the length should be less than 100. Does not apply to leaderboards initialized with players. Exception will be thrown if developer tries to set an invalid range. API-Since: 4.0 Deprecated-Since: 14.0
      • setTimeScope

        @Deprecated
        public void setTimeScope​(long value)
        Deprecated.
        API-Since: 4.0 Deprecated-Since: 14.0
      • timeScope

        @Deprecated
        public long timeScope()
        Deprecated.
        API-Since: 4.0 Deprecated-Since: 14.0
      • title

        @Nullable
        public @Nullable java.lang.String title()
        Localized title
      • baseLeaderboardID

        @NotNull
        public @NotNull java.lang.String baseLeaderboardID()
        Leaderboard ID defined in App Store Connect that this instance is associated with API-Since: 14.0
      • duration

        public double duration()
        Duration from startDate during which this leaderboard instance accepts score submissions (only applicable to recurring leaderboards) API-Since: 14.0
      • loadEntriesForPlayerScopeTimeScopeRangeCompletionHandler

        public void loadEntriesForPlayerScopeTimeScopeRangeCompletionHandler​(long playerScope,
                                                                             long timeScope,
                                                                             NSRange range,
                                                                             @NotNull
                                                                             @NotNull GKLeaderboard.Block_loadEntriesForPlayerScopeTimeScopeRangeCompletionHandler completionHandler)
        Loads leaderboard entries based on the supplied parameters. playerScope - Friends or Global timeScope - Today, Week, All Time (Only applicable to classic leaderboards) range - Range of ranked entries to return (minimum start index 1, maximum length 100) Upon completion, will return: localPlayerEntry - entry for the local player entries - requested entries matching supplied parameters totalPlayerCount - total player count matching specified scope API-Since: 14.0
      • loadEntriesForPlayersTimeScopeCompletionHandler

        public void loadEntriesForPlayersTimeScopeCompletionHandler​(@NotNull
                                                                    @NotNull NSArray<? extends GKPlayer> players,
                                                                    long timeScope,
                                                                    @NotNull
                                                                    @NotNull GKLeaderboard.Block_loadEntriesForPlayersTimeScopeCompletionHandler completionHandler)
        Loads leaderboard entries for specific players based on the supplied parameters. players - Array of players to load entries for timeScope - Today, Week, All Time (Only applicable to classic leaderboards) Upon completion, will return: localPlayerEntry - entry for the local player entries - requested entries matching supplied parameters API-Since: 14.0
      • loadLeaderboardsWithIDsCompletionHandler

        public static void loadLeaderboardsWithIDsCompletionHandler​(@Nullable
                                                                    @Nullable NSArray<java.lang.String> leaderboardIDs,
                                                                    @NotNull
                                                                    @NotNull GKLeaderboard.Block_loadLeaderboardsWithIDsCompletionHandler completionHandler)
        Loads classic and recurring leaderboards associated with the supplied App Store Connect leaderboard IDs. If leaderboardIDs is nil, this loads all classic and recurring leaderboards for this game. API-Since: 14.0
      • loadPreviousOccurrenceWithCompletionHandler

        public void loadPreviousOccurrenceWithCompletionHandler​(@NotNull
                                                                @NotNull GKLeaderboard.Block_loadPreviousOccurrenceWithCompletionHandler completionHandler)
        Loads the occurrence preceding this occurrence for a recurring leaderboard in which the local player submitted a score. If no previous occurrence is found that the player submitted a score to, then the most recent previous occurrence is returned. API-Since: 14.0
      • nextStartDate

        @Nullable
        public @Nullable NSDate nextStartDate()
        Date and time the next instance will start accepting score submissions (only applicable to recurring leaderboards) API-Since: 14.0
      • startDate

        @Nullable
        public @Nullable NSDate startDate()
        Date and time this instance started accepting score submissions (only applicable to recurring leaderboards) API-Since: 14.0
      • submitScoreContextPlayerCompletionHandler

        public void submitScoreContextPlayerCompletionHandler​(long score,
                                                              long context,
                                                              @NotNull
                                                              @NotNull GKPlayer player,
                                                              @NotNull
                                                              @NotNull GKLeaderboard.Block_submitScoreContextPlayerCompletionHandler completionHandler)
        Instance method to submit a single score to the leaderboard associated with this instance score - earned by the player context - developer supplied metadata associated with the player's score player - the player for whom this score is being submitted API-Since: 14.0
      • submitScoreContextPlayerLeaderboardIDsCompletionHandler

        public static void submitScoreContextPlayerLeaderboardIDsCompletionHandler​(long score,
                                                                                   long context,
                                                                                   @NotNull
                                                                                   @NotNull GKPlayer player,
                                                                                   @NotNull
                                                                                   @NotNull NSArray<java.lang.String> leaderboardIDs,
                                                                                   @NotNull
                                                                                   @NotNull GKLeaderboard.Block_submitScoreContextPlayerLeaderboardIDsCompletionHandler completionHandler)
        Class method to submit a single score to multiple leaderboards score - earned by the player context - developer supplied metadata associated with the player's score player - the player for whom this score is being submitted leaderboardIDs - one or more leaderboard IDs defined in App Store Connect API-Since: 14.0
      • type

        public long type()
        Type of leaderboard API-Since: 14.0
      • useStoredAccessor

        @Deprecated
        public static boolean useStoredAccessor()
        Deprecated.