Inherits from NSObject
Declared in FBSDKTestUsersManager.h

Overview

@class FBSDKTestUsersManager

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.

Class Methods

sharedInstanceForAppID:appSecret:

construct or return the shared instance

+ (instancetype)sharedInstanceForAppID:(NSString *)appID appSecret:(NSString *)appSecret

Parameters

appID

the Facebook app id

appSecret

the Facebook app secret

Declared In

FBSDKTestUsersManager.h

Instance Methods

addTestAccountWithPermissions:completionHandler:

add a test account with the specified permissions

- (void)addTestAccountWithPermissions:(NSSet *)permissions completionHandler:(FBSDKTestUsersManagerRetrieveTestAccountTokensHandler)handler

Parameters

permissions

the set of permissions, e.g., [NSSet setWithObjects:@“email”, @“user_friends”]

handler

the callback handler

Declared In

FBSDKTestUsersManager.h

makeFriendsWithFirst:second:callback:

Make two test users friends with each other.

- (void)makeFriendsWithFirst:(FBSDKAccessToken *)first second:(FBSDKAccessToken *)second callback:(void ( ^ ) ( NSError *))callback

Parameters

first

the token of the first user

second

the token of the second user

callback

the callback handler

Declared In

FBSDKTestUsersManager.h

removeTestAccount:completionHandler:

remove a test account for the given user id

- (void)removeTestAccount:(NSString *)userId completionHandler:(FBSDKTestUsersManagerRemoveTestAccountHandler)handler

Parameters

userId

the user id

handler

the callback handler

Declared In

FBSDKTestUsersManager.h

requestTestAccountTokensWithArraysOfPermissions:createIfNotFound:completionHandler:

retrieve FBSDKAccessToken instances for test accounts with the specific permissions.

- (void)requestTestAccountTokensWithArraysOfPermissions:(NSArray *)arraysOfPermissions createIfNotFound:(BOOL)createIfNotFound completionHandler:(FBSDKTestUsersManagerRetrieveTestAccountTokensHandler)handler

Parameters

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.

createIfNotFound

if YES, new test accounts are created if no test accounts existed that fit the permissions requirement

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.

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