FBSDKTestUsersManager Class Reference
Inherits from | NSObject |
Declared in | FBSDKTestUsersManager.h |
Overview
Provides methods for managing test accounts for testing Facebook integration.
Facebook allows developers to create test accounts for testing their applications' Facebook integration (see https://developers.facebook.com/docs/test_users/). This class simplifies use of these accounts for writing tests. It is not designed for use in production application code.
This class will make Graph API calls on behalf of your app to manage test accounts and requires an app id and app secret. You will typically use this class to write unit or integration tests. Make sure you NEVER include your app secret in your production app.
Instance Methods
addTestAccountWithPermissions:completionHandler:
add a test account with the specified permissions - Parameter permissions: the set of permissions, e.g., [NSSet setWithObjects:@“email”, @“user_friends”] - Parameter handler: the callback handler
- (void)addTestAccountWithPermissions:(NSSet *)permissions completionHandler:(FBSDKTestUsersManagerRetrieveTestAccountTokensHandler)handler
Declared In
FBSDKTestUsersManager.h
makeFriendsWithFirst:second:callback:
Make two test users friends with each other. - Parameter first: the token of the first user - Parameter second: the token of the second user - Parameter callback: the callback handler
- (void)makeFriendsWithFirst:(FBSDKAccessToken *)first second:(FBSDKAccessToken *)second callback:(void ( ^ ) ( NSError *))callback
Declared In
FBSDKTestUsersManager.h
removeTestAccount:completionHandler:
remove a test account for the given user id - Parameter userId: the user id - Parameter handler: the callback handler
- (void)removeTestAccount:(NSString *)userId completionHandler:(FBSDKTestUsersManagerRemoveTestAccountHandler)handler
Declared In
FBSDKTestUsersManager.h
requestTestAccountTokensWithArraysOfPermissions:createIfNotFound:completionHandler:
retrieve FBSDKAccessToken instances for test accounts with the specific permissions.
- Parameter arraysOfPermissions: an array of permissions sets, such as @[ [NSSet setWithObject:@“email”], [NSSet setWithObject:@“user_birthday”]]
if you needed two test accounts with email and birthday permissions, respectively. You can pass in empty nested sets
if you need two arbitrary test accounts. For convenience, passing nil is treated as @[ [NSSet set] ]
for fetching a single test user.
- Parameter createIfNotFound: if YES, new test accounts are created if no test accounts existed that fit the permissions
requirement
- Parameter handler: the callback to invoke which will return an array of FBAccessTokenData
instances or an NSError
.
If param createIfNotFound
is NO, the array may contain [NSNull null]
instances.
- (void)requestTestAccountTokensWithArraysOfPermissions:(NSArray *)arraysOfPermissions createIfNotFound:(BOOL)createIfNotFound completionHandler:(FBSDKTestUsersManagerRetrieveTestAccountTokensHandler)handler
Discussion
If you are requesting test accounts with differing number of permissions, try to order
arrayOfPermissionsArrays
so that the most number of permissions come first to minimize creation of new
test accounts.
Declared In
FBSDKTestUsersManager.h