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.


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
Sign up for Free and start developing right away!
I want to make Games
I want to make Apps
Game Development
Cross-Platform, Any Resolution

Use one IDE to deploy to all supported platforms, including iOS and Android, from a single code base.

Support all screen resolutions, aspect ratios and sizes with auto-adapting UI elements, smart scene scaling and memory efficient asset selection.

Learn More

V-Play ranked #1 at research2guidance cross-platform tool benchmarking 2014 by 2188 developers comparing 40 leading tools.

Multiplayer

V-Play Multiplayer supports both real-time and turn-based gameplay, so you can use it to make many different types of cross-platform multiplayer games. It's perfect for making player-vs-player games like 'Words with Friends' or games for a large amount of players, such as 'Clash of Clans'.

Learn More Video

Highscores & Achievements

The V-Play Game Network is a cross-platform gaming service that allows players around the world to compare game highscores and achievements. Players can also challenge each other across multiple platforms and share their progress on Facebook.

Learn More

QML & JavaScript

Qt Meta Language is a highly intuitive reactive language, which is super easy to learn, yet it's extremely powerful and flexible. Mix it with JavaScript to create awesome stuff, with just a few lines of code.

import QtQuick 2.0
import VPlay 2.0

GameWindow {
  Scene {
    
    SimpleButton {
      anchors.centerIn: parent
      text: "Press Me"
      onClicked: {
        console.debug("Wow you pressed me!")
      }
    }
  }
}

Learn More

Monetize & Analyze

With V-Play, you can use many 3rd party services for ads, in-app purchases, analytics and more, with just a few lines of code. All of these plugins work cross-platform, which allows you to maintain a single code base.

Learn More

Level Editor

The LevelEditor can be used during development to create and modify levels for your game, which you can then bundle in your final publishing build. Additionally, you can also integrate the in-game level editor to your published game and let your gamers create new levels.

Learn More Video

Card Game like UNO, Hearthstone or Poker

We got a demo game for you!

The V-Play SDK includes an open-source demo for this game genre. You can use its source code and build your game in record time. After installing V-Play, you can simply open the .pro file with Qt Creator, the development environment used for V-Play.

<Path to V-PlaySDK>/Examples/V-Play/demos/OneCard/OneCard.pro

Match-3 like Candy Crush Saga

We got a demo game for you!

The V-Play SDK includes an open-source demo for this game genre. You can use its source code and build your game in record time. After installing V-Play, you can simply open the .pro file with Qt Creator, the development environment used for V-Play.

<Path to V-PlaySDK>/Examples/V-Play/demos/JuicySquash/JuicySquash.pro

<Path to V-PlaySDK>/Examples/V-Play/demos/JuicySquashAdvanced/JuicySquashAdvanced.pro

Puzzle like 2048 or Threes!

We got a demo game for you!

The V-Play SDK includes an open-source demo for this game genre. You can use its source code and build your game in record time. After installing V-Play, you can simply open the .pro file with Qt Creator, the development environment used for V-Play.

<Path to V-PlaySDK>/Examples/V-Play/demos/2048/2048.pro

Casino like Big Win Slots

We got a demo game for you!

The V-Play SDK includes an open-source demo for this game genre. You can use its source code and build your game in record time. After installing V-Play, you can simply open the .pro file with Qt Creator, the development environment used for V-Play.

<Path to V-PlaySDK>/Examples/V-Play/demos/FlaskOfRum/FlaskOfRum.pro

Side Scroller like Jetpack Joyride or Flappy Bird

We got a demo game for you!

The V-Play SDK includes an open-source demo for this game genre. You can use its source code and build your game in record time. After installing V-Play, you can simply open the .pro file with Qt Creator, the development environment used for V-Play.

<Path to V-PlaySDK>/Examples/V-Play/demos/FlappyBird/FlappyBird.pro

Tower Defense like Castle Defense or Bloons TD

We got a demo game for you!

The V-Play SDK includes an open-source demo for this game genre. You can use its source code and build your game in record time. After installing V-Play, you can simply open the .pro file with Qt Creator, the development environment used for V-Play.

<Path to V-PlaySDK>/Examples/V-Play/demos/Squaby/Squaby.pro

Falldown & Jump like Doodle Jump or Mega Jump

We got a demo game for you!

The V-Play SDK includes an open-source demo for this game genre. You can use its source code and build your game in record time. After installing V-Play, you can simply open the .pro file with Qt Creator, the development environment used for V-Play.

<Path to V-PlaySDK>/Examples/V-Play/demos/ChickenOutbreak/ChickenOutbreak.pro

<Path to V-PlaySDK>/Examples/V-Play/demos/ChickenOutbreak2/ChickenOutbreak2.pro

<Path to V-PlaySDK>/Examples/V-Play/demos/DoodleJump/DoodleJump.pro

Platformer like Super Mario or Lep's World

We got a demo game for you!

The V-Play SDK includes an open-source demo for this game genre. You can use its source code and build your game in record time. After installing V-Play, you can simply open the .pro file with Qt Creator, the development environment used for V-Play.

<Path to V-PlaySDK>/Examples/V-Play/demos/Platformer/Platformer.pro

<Path to V-PlaySDK>/Examples/V-Play/demos/PlatformerWithLevelEditor/PlatformerWithLevelEditor.pro

Action like Angry Birds, Fruit Ninja, Cut the Rope

We got a demo game for you!

The V-Play SDK includes an open-source demo for this game genre. You can use its source code and build your game in record time. After installing V-Play, you can simply open the .pro file with Qt Creator, the development environment used for V-Play.

<Path to V-PlaySDK>/Examples/V-Play/demos/StackTheBoxWithCommunityEditor/StackTheBoxWithCommunityEditor.pro

<Path to V-PlaySDK>/Examples/V-Play/demos/BalloonPop/BalloonPop.pro

<Path to V-PlaySDK>/Examples/V-Play/demos/CarChallenge/CarChallenge.pro

Arcade like Arkanoid or Space Invaders

We got a demo game for you!

The V-Play SDK includes an open-source demo for this game genre. You can use its source code and build your game in record time. After installing V-Play, you can simply open the .pro file with Qt Creator, the development environment used for V-Play.

<Path to V-PlaySDK>/Examples/V-Play/demos/ZombieBreak/ZombieBreak.pro

Community like Super Mario Maker or Minecraft

We got a demo game for you!

The V-Play SDK includes an open-source demo for this game genre. You can use its source code and build your game in record time. After installing V-Play, you can simply open the .pro file with Qt Creator, the development environment used for V-Play.

<Path to V-PlaySDK>/examples/Squaby/Squaby.pro

<Path to V-PlaySDK>/Examples/V-Play/demos/StackTheBoxWithCommunityEditor/StackTheBoxWithCommunityEditor.pro

<Path to V-PlaySDK>/Examples/V-Play/demos/PlatformerWithLevelEditor/PlatformerWithLevelEditor.pro

Any other Idea? let us know how we can help you

You are looking for another demo?

The V-Play SDK includes many open-source demos for different game genres. You can use their source code and build your game in record time. After installing V-Play, you can simply open the .pro file with Qt Creator, the development environment used for V-Play.

If you do not find your game genre in this list and wonder if V-Play is the right choice, just contact us, we are happy to help!

Contact Us

App Development
Better Apps, Less Effort

Develop feature-rich, cross-platform mobile apps from a single code base.

V-Play apps look, feel and perform exactly like native iOS, Android and Desktop apps. With less code & much faster development time.

Learn More Highlights Video

V-Play ranked #1 at research2guidance cross-platform tool benchmarking 2014 by 2188 developers comparing 40 leading tools.

Save Time, Code & Money

Save up to 90% source code with V-Play, compared to frameworks like Xamarin, Titanium, React Native and others.

Learn More

QML & JavaScript

Qt Meta Language is a highly intuitive reactive language, which is super easy to learn, yet it's extremely powerful and flexible. Mix it with JavaScript to create awesome stuff, with just a few lines of code. QML also allows you to easily create smooth and complex animations.

import QtQuick 2.0
import VPlayApps 2.0

App {
  Page {
    
    AppButton {
      anchors.centerIn: parent
      text: "Press Me"
      onClicked: {
        console.debug("Wow you pressed me!")
      }
    }
  }
}

Learn More

Monetize & Analyze

With V-Play, you can use many 3rd party services for ads, in-app purchases, analytics and more, with just a few lines of code. All of these plugins work cross-platform, which allows you to maintain a single code base.

Learn More

Native Sensors & More

V-Play Apps harness the power of Qt, the leading cross-platform development framework used by over 1,000,000 developers.

This gives your access to native device features like sensors, camera, file system as well as multimedia, networking, localization and much more.

Learn More

Responsive Design

V-Play has built in responsive design capabilities, you can target phones and tablets with the same source code.

Learn More

Highly Extensible

You have existing JavaScript, C++ or native code? You want to add any 3rd party SDK that we do not offer already?

No worries, you can add any JS, C++, Java or Objective-C code to your project.

Learn More

Component Showcase App shows the most important V-Play features and components

We got a demo app for you!

The V-Play SDK includes an open-source demo for this app type. You can use its source code and build your app in record time. After installing V-Play, you can simply open the .pro file with Qt Creator, the development environment used for V-Play.

<Path to V-PlaySDK>/Examples/V-Play/appdemos/showcase/Showcase.pro

Qt World Summit Conference App a full-featured conference management app made by V-Play

We got a demo app for you!

The V-Play SDK includes an open-source demo for this app type. You can use its source code and build your app in record time. After installing V-Play, you can simply open the .pro file with Qt Creator, the development environment used for V-Play.

<Path to V-PlaySDK>/Examples/V-Play/appdemos/qtws2016/QtWS2016.pro

Twitter App how to build layouts like in the official Twitter app for iOS and Android

We got a demo app for you!

The V-Play SDK includes an open-source demo for this app type. You can use its source code and build your app in record time. After installing V-Play, you can simply open the .pro file with Qt Creator, the development environment used for V-Play.

<Path to V-PlaySDK>/Examples/V-Play/appdemos/twitter/Twitter.pro

Maps App displays free bikes or boxes at bike stations for Vienna's bike sharing service Citybike Wien

We got a demo app for you!

The V-Play SDK includes an open-source demo for this app type. You can use its source code and build your app in record time. After installing V-Play, you can simply open the .pro file with Qt Creator, the development environment used for V-Play.

<Path to V-PlaySDK>/Examples/V-Play/appdemos/maps/Maps.pro

Messaging App demonstrates how to create the UI of a Facebook Messenger like app

We got a demo app for you!

The V-Play SDK includes an open-source demo for this app type. You can use its source code and build your app in record time. After installing V-Play, you can simply open the .pro file with Qt Creator, the development environment used for V-Play.

<Path to V-PlaySDK>/Examples/V-Play/appdemos/messaging/Messaging.pro

Weather App how to include powerful animations into your user interface

We got a demo app for you!

The V-Play SDK includes an open-source demo for this app type. You can use its source code and build your app in record time. After installing V-Play, you can simply open the .pro file with Qt Creator, the development environment used for V-Play.

<Path to V-PlaySDK>/Examples/V-Play/appdemos/waether/Weather.pro

Any other Idea? let us know how we can help you

You are looking for another app demo?

The V-Play SDK includes many open-source demos for different app types. You can use their source code and build your app in record time. After installing V-Play, you can simply open the .pro file with Qt Creator, the development environment used for V-Play..

If you do not find your app type in this list and wonder if V-Play is the right choice, just contact us, we are happy to help!

Contact Us