Facebook

The Facebook item provides access to the native Facebook SDK on iOS and Android. More...

Import Statement: import VPlayPlugins.facebook 1.0
Inherits:

Item

Properties

Signals

Methods

Detailed Description

You can use the Facebook item to retrieve information about a logged in user, to send generic graph requests and to open a wall post dialog or a friendpicker dialog.

For more information also have a look at Facebook Plugin.

Property Documentation

accessToken : string

A read-only property returning the currently logged-in user's Facebook access token. Please note that there is no onAccessTokenChanged signal. Instead, you can read the updated accessToken after a call to openSession().

The accessToken can be used to send Facebook requests from outside your app, for example your server backend. It is valid for about 60 days and expires afterwards. After a call to openSession() you can store the accessToken and later on send other web requests with the same token for about 60 days. At every further openSession() call at application startup, the accessToken will stay the same until it expires. Thus in applications it is preferable to call openSession() when the application starts for example in Component.onCompleted() and afterwards work with the accessToken.

Note: If you call closeSession() before openSession(), a new token is created.

See Facebook SSO for more informations on how long a user is active and how the user credentials are stored.

See also openSession() and closeSession().


appId : string

Your Facebook application's app id. Be sure to set this property before calling any Facebook request functions, any changes afterwards will be ignored and will result in a ResultState of NoSession.

If you want separate Facebook apps for iOS and Android, you can use the following example code:

 Facebook {
   // A different application key is used for Android and iOS
   appId: Qt.platform.os === "ios" ? "<ios-appp-id>" : "<android-app-id>"
 }

grantedPermissions : list<string>

The read-only grantedPermissions property contains a list of the current Facebook permissions granted by the user.

Regardless of your defined readPermissions and publishPermissions a user can simply deny a certain permission for your app. This property allows you to check the granted permissons if some requests may fail.

A full list of available permissions can be found at the Facebook Login Permissions.

See also readPermissions and publishPermissions.


profile : FacebookProfile

A read-only property returning information about the currently logged in user. More details are listed at FacebookProfile.


publishPermissions : list<string>

The publishPermissions property contains a list of permissions needed for POST graph requests.

A full list of available permissions can be found at the Facebook Login Permissions.

Note: If your app asks for more than than public_profile, email and user_friends it will require review by Facebook before your app can be used by people other than you as the app developer.

The example below requests basic publish actions permissions. The publish_actions permission allows your app to post on the news feed or posting scores for games.

 Facebook {
   publishPermissions: [ "publish_actions" ]
 }

See also readPermissions and grantedPermissions.


readPermissions : list<string>

The readPermissions property contains a list of permissions needed for GET graph requests.

A full list of available permissions can be found at the Facebook Login Permissions.

If no readPermissions are specified, the default permissions include access to the user name, first and last name, the gender, locale and the Facebook user id.

Note: If your app asks for more than than public_profile, email and user_friends it will require review by Facebook before your app can be used by people other than you as the app developer.

This example additionally requests access to the email address and access to the user's friends:

 Facebook {
   readPermissions: [ "email", "user_friends" ]
 }

See also publishPermissions and grantedPermissions.


sessionState : enumeration

Read only property holding the state of the current Facebook session. You have to open a session with openSession() before sending any requests to the Facebook API.

The possible values for sessionState are:

  • Facebook.NoSession (for newly initialized sessions without any interaction so far)
  • Facebook.SessionOpening (for sessions currently being opened after a call to openSession())
  • Facebook.SessionOpened (for successfully opened sessions after calling openSession())
  • Facebook.SessionClosed (for closed sessions after calling closeSession())
  • Facebook.SessionFailed (for failed sessions during authentication with openSession())
  • Facebook.SessionPermissionDenied (for sessions where the user denied a certain permission request)

Please also have a look at Facebook SSO for more informations how long a user is active and how the user credentials are stored.


Signal Documentation

onFriendPickerDialogFinished(enumeration resultState, list<FacebookProfile> friends)

This handler is called after the user closes the openFriendPickerDialog dialog. In case the user selected some friends the resultState is Facebook:ResultOk and the friends list parameter contains the friend's FacebookProfile items. Otherwise the resultState is Facebook.ResultError.

Note: You can request additional information about a specific friend with getGraphRequest().


onGetGraphRequestFinished(string graphPath, enumeration resultState, string result)

This handler is called after the getGraphRequest() request has finished. graphPath contains the initial sent API path.

The possible values for resultState are:

  • Facebook.ResultOk (request successfully performed)
  • Facebook.ResultPermissionDenied (the user did not allow the requested permissions for a getGraphRequest() request)
  • Facebook.ResultError (the request ended with another error)
  • Facebook.ResultInvalidSession (the plugin needs an open session before it can call the API, make sure to call openSession() before)

If resultState is Facebook.Ok the result parameter contains the requested json response object in string representation.


onOpenSessionFailed(string reason)

This handler provides additional information from the Facebook SDK if a call to openSession() result in a Facebook.SessionFailed or Facebook.SessionPermissionDenied resultState.


onPostGraphRequestFinished(string graphPath, enumeration resultState, string result)

This handler is called after the postGraphRequest() request has finished. graphPath contains the initial sent API path.

The possible values for resultState are:

  • Facebook.ResultOk (request successfully performed)
  • Facebook.ResultPermissionDenied (the user did not allow the requested permissions for a postGraphRequest() request)
  • Facebook.ResultError (the request ended with another error)
  • Facebook.ResultInvalidSession (the plugin needs an open session before it can call the API, make sure to call openSession() before)

If resultState is Facebook.Ok the result parameter contains the requested json response object in string representation.


Method Documentation

void closeSession()

Closes an active session with Facebook. You don't have to call this function explicitly as the session gets closed when exiting the app automatically.

See also sessionState.


void fetchUserDetails()

Call this method to fetch additional user details into the profile property. Here is an example how to get the currently logged in user details after opening a session:

 Facebook {
   appId: "YOUR_APP_ID"

   Component.onComplete: {
     openSession();
   }

   onSessionStateChanged: {
     if (sessionState === Facebook.SessionOpened) {
       fetchUserDetails()
     }
   }

   onProfileChanged: {
     console.debug("Currently logged in user last name:", profile.lastName)
   }
 }

void getGraphRequest(string graphPath, variant params)

Sends a read request to the Graph API at graphPath path with a params map (optional) by using the http GET method.

The full documenation about the OpenGraph API can be found at http://developers.facebook.com/docs/reference/api/.

The following example queries the Facebook friends of the currently logged in user:

 facebook.getGraphRequest("me/friends");

Note: For receiving the friends list, the readPermissions property must contain the user_friends permission.

See also onGetGraphRequestFinished.


void openFriendPickerDialog(bool allowsMultipleSelection)

Opens a dialog to pick one or multiple friends depending on the allowsMultipleSelection parameter. If you omit the parameter the default value for allowsMultipleSelection is true. You can retrieve the selected friends in onFriendPickerDialogFinished as soon as the user closes the dialog again.

The picker only shows friends that are also using your app and therefore have authorized it too.

Note: In order to display the friend list make sure to add the user_friends permission to the list of readPermissions.

See also onFriendPickerDialogFinished.


void openSession()

Call this method to authorize your game and open an active session. Be sure to call openSession() in your app before sending any request to the Facebook API.

The following example opens a session at app startup and prints information about session state changes:

 Facebook {
   id: facebook
   appId: "YOUR_APP_ID"

   onSessionStateChanged: {
     if (sessionState === Facebook.SessionOpened) {
       console.debug("Session opened.");
     }
     else if (sessionState === Facebook.SessionOpening) {
       console.debug("Session opening...");
     }
     else if (sessionState === Facebook.SessionClosed) {
       console.debug("Session closed.");
     }
     else if (sessionState === Facebook.SessionFailed) {
       console.debug("Session failed.");
     }
     else if (sessionState === Facebook.SessionPermissionDenied) {
       console.debug("User denied requested permissions.");
     }
   }

   Component.onComplete: {
     facebook.openSession();
   }

 }

See Facebook SSO for more informations how long a user is active and how the user credentials are stored automatically.

See also sessionState.


void postGraphRequest(string graphPath, variant params)

Sends a publish request to the Graph API at graphPath path with a params map (optional) by using the http POST method.

The full documenation about the OpenGraph API can be found at http://developers.facebook.com/docs/reference/api/.

The following example posts to the currently logged in user's wall:

 facebook.postGraphRequest("me/feed", { "message" : "Secret message from www.v-play.net!" });

See also onPostGraphRequestFinished.


Videos

Voted #1 for:

  • Easiest to learn
  • Most time saving
  • Best support

Develop Cross-Platform Apps and Games 50% Faster!

  • Voted the best supported, most time-saving and easiest to learn cross-platform development tool
  • Based on the Qt framework, with native performance and appearance on all platforms including iOS and Android
  • Offers a variety of plugins to monetize, analyze and engage users
FREE!
create apps
create games
cross platform
native performance
3rd party services
game network
multiplayer
level editor
easiest to learn
biggest time saving
best support