//
//  GKChallenge.h
//  GameKit
//
//  Copyright 2012 Apple Inc. All rights reserved.
//

#import <Foundation/Foundation.h>
#import <GameKit/GKScore.h>
#import <GameKit/GKAchievement.h>
#import <GameKit/GKDefines.h>

typedef NS_ENUM(NSInteger, GKChallengeState) {
    GKChallengeStateInvalid = 0,
    GKChallengeStatePending = 1, // The challenge has been issued, but neither completed nor declined
    GKChallengeStateCompleted = 2, // The challenge has been completed by the receiving player
    GKChallengeStateDeclined = 3, // The challenge has been declined by the receiving player
};

NS_CLASS_AVAILABLE(10_9, 6_0)
@interface GKChallenge : NSObject <NSCoding>
{
@private
    id _internal;
    id _internal3;
}

// Query challenges for the current game issued to the local player -- equivalent GKChallenge objects are not guaranteed to be pointer equivalent across calls, but equal GKChallenge objects will have equal hashes
+ (void)loadReceivedChallengesWithCompletionHandler:(void(^)(NSArray *challenges, NSError *error))completionHandler;

// Any GKChallenge object to be declined must be in a state of GKChallengeStatePending in order to be successfully cancelled
- (void)decline;

@property (readonly, copy, NS_NONATOMIC_IOSONLY) NSString *issuingPlayerID; // The GKPlayer who issued the challenge
@property (readonly, copy, NS_NONATOMIC_IOSONLY) NSString *receivingPlayerID; // The GKPlayer who has received the challenge
@property (readonly, assign, NS_NONATOMIC_IOSONLY) GKChallengeState state; // Current state of the challenge
@property (readonly, retain, NS_NONATOMIC_IOSONLY) NSDate *issueDate; // Date the challenge was issued
@property (readonly, retain, NS_NONATOMIC_IOSONLY) NSDate *completionDate; // Date the challenge was completed or aborted
@property (readonly, copy, NS_NONATOMIC_IOSONLY) NSString *message; // The message sent to receivers of this challenge

@end

NS_CLASS_AVAILABLE(10_9, 6_0)
@interface GKScoreChallenge : GKChallenge
{
@private
    id _internal1;
}
@property (readonly, retain, NS_NONATOMIC_IOSONLY) GKScore *score; // The score to meet to satisfy this challenge
@end

NS_CLASS_AVAILABLE(10_9, 6_0)
@interface GKAchievementChallenge : GKChallenge
{
@private
    id _internal1;
}
@property (readonly, retain, NS_NONATOMIC_IOSONLY) GKAchievement *achievement; // The achievement to achieve to satisfy this challenge
@end


// Use the following category methods to issue GKScoreChallenges and GKAchievementChallenges to an array of playerIDs. Players may not issue challenges to themselves nor to non-friends. Please see the GameKit reference documentation for further details on these methods.
@interface GKScore (GKChallenge)
- (void)issueChallengeToPlayers:(NSArray *)playerIDs message:(NSString *)message __OSX_AVAILABLE_STARTING(__MAC_10_9,__IPHONE_6_0);
@end

@interface GKAchievement (GKChallenge)

// If an achievement has already been earned by the receiving player, and that achievement is not marked as replayable in iTunes connect, then the challenge will not be issued to the player. If an achievement is hidden, then it will not be issued.
- (void)issueChallengeToPlayers:(NSArray *)playerIDs message:(NSString *)message __OSX_AVAILABLE_STARTING(__MAC_10_9,__IPHONE_6_0);

// Given a list of playerIDs, return a subset of that list containing only playerIDs that are eligible to receive a challenge for the achievement.
- (void)selectChallengeablePlayerIDs:(NSArray *)playerIDs withCompletionHandler:(void(^)(NSArray *challengeablePlayerIDs, NSError *error))completionHandler __OSX_AVAILABLE_STARTING(__MAC_10_9,__IPHONE_6_0);

@end