3.9.2

lpw

2021-01-26 49b8839fda3439edc31581527e84036e58f55f0f

 frameworks/FBSDKCoreKit.framework/Headers/FBSDKAccessToken.h

@@ -18,22 +18,46 @@

#import <Foundation/Foundation.h>

#import <FBSDKCoreKit/FBSDKCopying.h>
#import <FBSDKCoreKit/FBSDKGraphRequestConnection.h>
#import <FBSDKCoreKit/FBSDKMacros.h>
#import "FBSDKCopying.h"

/*!
 @abstract Notification indicating that the `currentAccessToken` has changed.
 @discussion the userInfo dictionary of the notification will contain keys
#ifdef BUCK
#import <FBSDKCoreKit/FBSDKGraphRequestConnection.h>
#else
#import "FBSDKGraphRequestConnection.h"
#endif

NS_ASSUME_NONNULL_BEGIN

#if __IPHONE_OS_VERSION_MAX_ALLOWED >= __IPHONE_10_0

/**
  Notification indicating that the `currentAccessToken` has changed.

 the userInfo dictionary of the notification will contain keys
 `FBSDKAccessTokenChangeOldKey` and
 `FBSDKAccessTokenChangeNewKey`.
 */
FBSDK_EXTERN NSString *const FBSDKAccessTokenDidChangeNotification;
FOUNDATION_EXPORT NSNotificationName const FBSDKAccessTokenDidChangeNotification
NS_SWIFT_NAME(AccessTokenDidChange);

/*!
 @abstract A key in the notification's userInfo that will be set
#else

/**
 Notification indicating that the `currentAccessToken` has changed.

 the userInfo dictionary of the notification will contain keys
 `FBSDKAccessTokenChangeOldKey` and
 `FBSDKAccessTokenChangeNewKey`.
 */
FOUNDATION_EXPORT NSString *const FBSDKAccessTokenDidChangeNotification
NS_SWIFT_NAME(AccessTokenDidChangeNotification);
#endif

/**
  A key in the notification's userInfo that will be set
  if and only if the user ID changed between the old and new tokens.
 @discussion Token refreshes can occur automatically with the SDK

 Token refreshes can occur automatically with the SDK
  which do not change the user. If you're only interested in user
  changes (such as logging out), you should check for the existence
  of this key. The value is a NSNumber with a boolValue.
@@ -42,125 +66,209 @@
  of an access token, this key will also exist since the access token
  is moving from a null state (no user) to a non-null state (user).
 */
FBSDK_EXTERN NSString *const FBSDKAccessTokenDidChangeUserID;
FOUNDATION_EXPORT NSString *const FBSDKAccessTokenDidChangeUserIDKey
NS_SWIFT_NAME(AccessTokenDidChangeUserIDKey);

/*
 @abstract key in notification's userInfo object for getting the old token.
 @discussion If there was no old token, the key will not be present.
  key in notification's userInfo object for getting the old token.

 If there was no old token, the key will not be present.
 */
FBSDK_EXTERN NSString *const FBSDKAccessTokenChangeOldKey;
FOUNDATION_EXPORT NSString *const FBSDKAccessTokenChangeOldKey
NS_SWIFT_NAME(AccessTokenChangeOldKey);

/*
 @abstract key in notification's userInfo object for getting the new token.
 @discussion If there is no new token, the key will not be present.
  key in notification's userInfo object for getting the new token.

 If there is no new token, the key will not be present.
 */
FBSDK_EXTERN NSString *const FBSDKAccessTokenChangeNewKey;
FOUNDATION_EXPORT NSString *const FBSDKAccessTokenChangeNewKey
NS_SWIFT_NAME(AccessTokenChangeNewKey);

/*
 A key in the notification's userInfo that will be set
 if and only if the token has expired.
 */
FOUNDATION_EXPORT NSString *const FBSDKAccessTokenDidExpireKey
NS_SWIFT_NAME(AccessTokenDidExpireKey);


/*!
 @class FBSDKAccessToken
 @abstract Represents an immutable access token for using Facebook services.
/**
  Represents an immutable access token for using Facebook services.
 */
NS_SWIFT_NAME(AccessToken)
@interface FBSDKAccessToken : NSObject<FBSDKCopying, NSSecureCoding>

/*!
 @abstract Returns the app ID.
 */
@property (readonly, copy, nonatomic) NSString *appID;

/*!
 @abstract Returns the known declined permissions.
 */
@property (readonly, copy, nonatomic) NSSet *declinedPermissions;
/**
  The "global" access token that represents the currently logged in user.

/*!
 @abstract Returns the expiration date.
 The `currentAccessToken` is a convenient representation of the token of the
 current user and is used by other SDK components (like `FBSDKLoginManager`).
 */
@property (readonly, copy, nonatomic) NSDate *expirationDate;
@property (class, nonatomic, copy, nullable) FBSDKAccessToken *currentAccessToken;

/*!
 @abstract Returns the known granted permissions.
/**
 Returns YES if currentAccessToken is not nil AND currentAccessToken is not expired

 */
@property (readonly, copy, nonatomic) NSSet *permissions;
@property (class, nonatomic, assign, readonly, getter=isCurrentAccessTokenActive) BOOL currentAccessTokenIsActive;

/*!
 @abstract Returns the date the token was last refreshed.
/**
  Returns the app ID.
 */
@property (nonatomic, copy, readonly) NSString *appID;

/**
 Returns the expiration date for data access
 */
@property (nonatomic, copy, readonly) NSDate *dataAccessExpirationDate;

/**
  Returns the known declined permissions.
 */
@property (nonatomic, copy, readonly) NSSet<NSString *> *declinedPermissions
NS_REFINED_FOR_SWIFT;

/**
 Returns the known declined permissions.
 */
@property (nonatomic, copy, readonly) NSSet<NSString *> *expiredPermissions
NS_REFINED_FOR_SWIFT;

/**
  Returns the expiration date.
 */
@property (nonatomic, copy, readonly) NSDate *expirationDate;

/**
  Returns the known granted permissions.
 */
@property (nonatomic, copy, readonly) NSSet<NSString *> *permissions
NS_REFINED_FOR_SWIFT;

/**
  Returns the date the token was last refreshed.
*/
@property (readonly, copy, nonatomic) NSDate *refreshDate;
@property (nonatomic, copy, readonly) NSDate *refreshDate;

/*!
 @abstract Returns the opaque token string.
/**
  Returns the opaque token string.
 */
@property (readonly, copy, nonatomic) NSString *tokenString;
@property (nonatomic, copy, readonly) NSString *tokenString;

/*!
 @abstract Returns the user ID.
/**
  Returns the user ID.
 */
@property (readonly, copy, nonatomic) NSString *userID;
@property (nonatomic, copy, readonly) NSString *userID;

/**
  The graph domain where this access token is valid.
 */
@property (nonatomic, copy, readonly) NSString *graphDomain;

/**
 Returns whether the access token is expired by checking its expirationDate property
 */
@property (readonly, assign, nonatomic, getter=isExpired) BOOL expired;

/**
 Returns whether user data access is still active for the given access token
 */
@property (readonly, assign, nonatomic, getter=isDataAccessExpired) BOOL dataAccessExpired;

- (instancetype)init NS_UNAVAILABLE;
+ (instancetype)new NS_UNAVAILABLE;

/*!
 @abstract Initializes a new instance.
/**
 Initializes a new instance.
 @param tokenString the opaque token string.
 @param permissions the granted permissions. Note this is converted to NSSet and is only
 an NSArray for the convenience of literal syntax.
 @param declinedPermissions the declined permissions. Note this is converted to NSSet and is only
 an NSArray for the convenience of literal syntax.
 @param expiredPermissions the expired permissions. Note this is converted to NSSet and is only
 an NSArray for the convenience of literal syntax.
 @param appID the app ID.
 @param userID the user ID.
 @param expirationDate the optional expiration date (defaults to distantFuture).
 @param refreshDate the optional date the token was last refreshed (defaults to today).
 @discussion This initializer should only be used for advanced apps that
 @param dataAccessExpirationDate the date which data access will expire for the given user
 (defaults to distantFuture).

 This initializer should only be used for advanced apps that
 manage tokens explicitly. Typical login flows only need to use `FBSDKLoginManager`
 along with `+currentAccessToken`.
 */
- (instancetype)initWithTokenString:(NSString *)tokenString
                        permissions:(NSArray *)permissions
                declinedPermissions:(NSArray *)declinedPermissions
                        permissions:(NSArray<NSString *> *)permissions
                declinedPermissions:(NSArray<NSString *> *)declinedPermissions
                 expiredPermissions:(NSArray<NSString *> *)expiredPermissions
                              appID:(NSString *)appID
                             userID:(NSString *)userID
                     expirationDate:(NSDate *)expirationDate
                        refreshDate:(NSDate *)refreshDate
                     expirationDate:(nullable NSDate *)expirationDate
                        refreshDate:(nullable NSDate *)refreshDate
           dataAccessExpirationDate:(nullable NSDate *)dataAccessExpirationDate
NS_DESIGNATED_INITIALIZER;

/*!
 @abstract Convenience getter to determine if a permission has been granted
/**
 Convenience initializer.
 @param tokenString the opaque token string.
 @param permissions the granted permissions. Note this is converted to NSSet and is only
 an NSArray for the convenience of literal syntax.
 @param declinedPermissions the declined permissions. Note this is converted to NSSet and is only
 an NSArray for the convenience of literal syntax.
 @param expiredPermissions the expired permissions. Note this is converted to NSSet and is only
 an NSArray for the convenience of literal syntax.
 @param appID the app ID.
 @param userID the user ID.
 @param expirationDate the optional expiration date (defaults to distantFuture).
 @param refreshDate the optional date the token was last refreshed (defaults to today).
 @param dataAccessExpirationDate the date which data access will expire for the given user
 (defaults to distantFuture).
 @param graphDomain the domain this access token can be used in.

 This initializer should only be used for advanced apps that
 manage tokens explicitly. Typical login flows only need to use `FBSDKLoginManager`
 along with `+currentAccessToken`.
 */
- (instancetype)initWithTokenString:(NSString *)tokenString
                        permissions:(NSArray<NSString *> *)permissions
                declinedPermissions:(NSArray<NSString *> *)declinedPermissions
                 expiredPermissions:(NSArray<NSString *> *)expiredPermissions
                              appID:(NSString *)appID
                             userID:(NSString *)userID
                     expirationDate:(nullable NSDate *)expirationDate
                        refreshDate:(nullable NSDate *)refreshDate
           dataAccessExpirationDate:(nullable NSDate *)dataAccessExpirationDate
                        graphDomain:(nullable NSString *)graphDomain;

/**
  Convenience getter to determine if a permission has been granted
 @param permission  The permission to check.
 */
- (BOOL)hasGranted:(NSString *)permission;
- (BOOL)hasGranted:(NSString *)permission
NS_SWIFT_NAME(hasGranted(permission:));

/*!
 @abstract Compares the receiver to another FBSDKAccessToken
/**
  Compares the receiver to another FBSDKAccessToken
 @param token The other token
 @return YES if the receiver's values are equal to the other token's values; otherwise NO
 */
- (BOOL)isEqualToAccessToken:(FBSDKAccessToken *)token;

/*!
 @abstract Returns the "global" access token that represents the currently logged in user.
 @discussion The `currentAccessToken` is a convenient representation of the token of the
 current user and is used by other SDK components (like `FBSDKLoginManager`).
 */
+ (FBSDKAccessToken *)currentAccessToken;

/*!
 @abstract Sets the "global" access token that represents the currently logged in user.
 @param token The access token to set.
 @discussion This will broadcast a notification and save the token to the app keychain.
 */
+ (void)setCurrentAccessToken:(FBSDKAccessToken *)token;

/*!
 @abstract Refresh the current access token's permission state and extend the token's expiration date,
/**
  Refresh the current access token's permission state and extend the token's expiration date,
  if possible.
 @param completionHandler an optional callback handler that can surface any errors related to permission refreshing.
 @discussion On a successful refresh, the currentAccessToken will be updated so you typically only need to

 On a successful refresh, the currentAccessToken will be updated so you typically only need to
  observe the `FBSDKAccessTokenDidChangeNotification` notification.

 If a token is already expired, it cannot be refreshed.
 */
+ (void)refreshCurrentAccessToken:(FBSDKGraphRequestHandler)completionHandler;
+ (void)refreshCurrentAccessToken:(nullable FBSDKGraphRequestBlock)completionHandler;

@end

NS_ASSUME_NONNULL_END