facebook4j.api

Interface TestUserMethods

All Known Subinterfaces:

Facebook

All Known Implementing Classes:

FacebookImpl

public interface TestUserMethods

Author:

Ryuji Yamashita - roundrop at gmail.com

Method Summary

Modifier and Type	Method and Description
TestUser	createTestUser(java.lang.String appId) Creates a test user associated with a particular app.
TestUser	createTestUser(java.lang.String appId, java.lang.String name, java.lang.String locale, java.lang.String permissions) Creates a test user associated with a particular app.
TestUser	createTestUser(java.lang.String appId, java.lang.String name, java.lang.String locale, java.lang.String permissions, boolean installed) Creates a test user associated with a particular app.
boolean	deleteTestUser(java.lang.String testUserId) Deletes the test user.
ResponseList<TestUser>	getTestUsers(java.lang.String appId) Returns test users associated with a particular app.
ResponseList<TestUser>	getTestUsers(java.lang.String appId, java.lang.Integer limit) Returns test users associated with a particular app.
boolean	makeFriendTestUser(TestUser testUser1, TestUser testUser2) Makes friends connections for a test user with other test users.

Method Detail

createTestUser

TestUser createTestUser(java.lang.String appId)
                 throws FacebookException

Creates a test user associated with a particular app.

Parameters:

appId - the ID of the app

Returns:

Test User

Throws:

FacebookException - when Facebook service or network is unavailable

See Also:

Test Users - Facebook Developers

createTestUser

TestUser createTestUser(java.lang.String appId,
                        java.lang.String name,
                        java.lang.String locale,
                        java.lang.String permissions)
                 throws FacebookException

Creates a test user associated with a particular app.

Parameters:

appId - the ID of the app

name - test user name

locale - locale

permissions - comma-separated list of permissions

Returns:

Test User

Throws:

FacebookException - when Facebook service or network is unavailable

See Also:

Test Users - Facebook Developers

createTestUser

TestUser createTestUser(java.lang.String appId,
                        java.lang.String name,
                        java.lang.String locale,
                        java.lang.String permissions,
                        boolean installed)
                 throws FacebookException

Creates a test user associated with a particular app.

Parameters:

appId - the ID of the app

name - test user name

locale - locale

permissions - comma-separated list of permissions

installed - automatically installs the app for the test user once it is created

Returns:

Test User

Throws:

FacebookException - when Facebook service or network is unavailable

See Also:

Test Users - Facebook Developers

getTestUsers

ResponseList<TestUser> getTestUsers(java.lang.String appId)
                             throws FacebookException

Returns test users associated with a particular app. This method can't manage paging

Parameters:

appId - the ID of the app

Returns:

Test Users

Throws:

FacebookException - when Facebook service or network is unavailable

See Also:

Test Users - Facebook Developers

getTestUsers

ResponseList<TestUser> getTestUsers(java.lang.String appId,
                                    java.lang.Integer limit)
                             throws FacebookException

Returns test users associated with a particular app. This method manage paging, call facebook.fetchNext to get next page

Parameters:

appId - the ID of the app

limit - number of elements per page (can be null to use default page size)

Returns:

Test Users first page

Throws:

FacebookException - when Facebook service or network is unavailable

See Also:

Test Users - Facebook Developers

deleteTestUser

boolean deleteTestUser(java.lang.String testUserId)
                throws FacebookException

Deletes the test user.

Parameters:

testUserId - the ID of the test user

Returns:

true if delete is successful

Throws:

FacebookException - when Facebook service or network is unavailable

See Also:

Test Users - Facebook Developers

makeFriendTestUser

boolean makeFriendTestUser(TestUser testUser1,
                           TestUser testUser2)
                    throws FacebookException

Makes friends connections for a test user with other test users.

Parameters:

testUser1 - test user

testUser2 - test user

Returns:

true on success, false otherwise

Throws:

FacebookException - when Facebook service or network is unavailable

See Also:

Test Users - Facebook Developers