// Copyright (c) 2014-present, Facebook, Inc. All rights reserved.
|
//
|
// You are hereby granted a non-exclusive, worldwide, royalty-free license to use,
|
// copy, modify, and distribute this software in source code or binary form for use
|
// in connection with the web services and APIs provided by Facebook.
|
//
|
// As with any software that integrates with the Facebook platform, your use of
|
// this software is subject to the Facebook Developer Principles and Policies
|
// [http://developers.facebook.com/policy/]. This copyright notice shall be
|
// included in all copies or substantial portions of the software.
|
//
|
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
// FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
// COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
|
// IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
// CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
#import <Foundation/Foundation.h>
|
|
#import "FBSDKCopying.h"
|
|
#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`.
|
*/
|
FOUNDATION_EXPORT NSNotificationName const FBSDKAccessTokenDidChangeNotification
|
NS_SWIFT_NAME(AccessTokenDidChange);
|
|
#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.
|
|
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.
|
|
On a fresh start of the app where the SDK reads in the cached value
|
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).
|
*/
|
FOUNDATION_EXPORT NSString *const FBSDKAccessTokenDidChangeUserIDKey
|
NS_SWIFT_NAME(AccessTokenDidChangeUserIDKey);
|
|
/*
|
key in notification's userInfo object for getting the old token.
|
|
If there was no old token, the key will not be present.
|
*/
|
FOUNDATION_EXPORT NSString *const FBSDKAccessTokenChangeOldKey
|
NS_SWIFT_NAME(AccessTokenChangeOldKey);
|
|
/*
|
key in notification's userInfo object for getting the new token.
|
|
If there is no new token, the key will not be present.
|
*/
|
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);
|
|
|
/**
|
Represents an immutable access token for using Facebook services.
|
*/
|
NS_SWIFT_NAME(AccessToken)
|
@interface FBSDKAccessToken : NSObject<FBSDKCopying, NSSecureCoding>
|
|
|
/**
|
The "global" access token that represents the currently logged in user.
|
|
The `currentAccessToken` is a convenient representation of the token of the
|
current user and is used by other SDK components (like `FBSDKLoginManager`).
|
*/
|
@property (class, nonatomic, copy, nullable) FBSDKAccessToken *currentAccessToken;
|
|
/**
|
Returns YES if currentAccessToken is not nil AND currentAccessToken is not expired
|
|
*/
|
@property (class, nonatomic, assign, readonly, getter=isCurrentAccessTokenActive) BOOL currentAccessTokenIsActive;
|
|
/**
|
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 (nonatomic, copy, readonly) NSDate *refreshDate;
|
|
/**
|
Returns the opaque token string.
|
*/
|
@property (nonatomic, copy, readonly) NSString *tokenString;
|
|
/**
|
Returns the user ID.
|
*/
|
@property (nonatomic, copy, readonly) NSString *userID;
|
|
/**
|
The graph domain where this access token is valid.
|
*/
|
@property (nonatomic, copy, readonly) NSString *graphDomain DEPRECATED_MSG_ATTRIBUTE("The graphDomain property will be removed from AccessToken in the next major release. Use the graphDomain property on AuthenticationToken instead.");
|
|
/**
|
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;
|
|
/**
|
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).
|
@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<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
|
NS_DESIGNATED_INITIALIZER;
|
|
/**
|
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
|
DEPRECATED_MSG_ATTRIBUTE("The graphDomain property will be removed from AccessToken in the next major release. Use initializers that do not take in graphDomain domain instead.");
|
|
/**
|
Convenience getter to determine if a permission has been granted
|
@param permission The permission to check.
|
*/
|
- (BOOL)hasGranted:(NSString *)permission
|
NS_SWIFT_NAME(hasGranted(permission:));
|
|
/**
|
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;
|
|
/**
|
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.
|
|
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:(nullable FBSDKGraphRequestBlock)completionHandler;
|
|
@end
|
|
NS_ASSUME_NONNULL_END
|
