Skip to content

Latest commit

 

History

History
137 lines (99 loc) · 5.48 KB

README.md

File metadata and controls

137 lines (99 loc) · 5.48 KB

Welcome to the ng-facebook-api

Facebook API wrapper for AngularJS, you don't have to worry about the configuration and working principles of Facebook JS SDK, you have only to code using our API.

Ready and easy to use.

See the official site

Demo

The module is now under developing, in the next weeks the module will be completed and we're going to put online the official docs.

##Configuration

  1. Download the library clicking here or use bower install ng-facebook-api
  2. Include Facebook JS SDK, only the SDK not the initialization window.fbAsyncInit and FB.init
  3. Modify your application inject the ng-facebook-api
  4. In your application config, you must setup the facebookProvider with your Facebook App settings. The settings are used in FB.init
  5. If your app uses extra permissions that require user approval, set in your config. You can set permissions also in the controller, obviously before using login.

Here an example of configuration:

angular
  .module('<your-app-name>',['ng-facebook-api'])
     .config(function( facebookProvider) {
        /**
        * Here the list of params used to configure the provider
        * @param appId
        * @param status
        * @param xfbml
        * @param cookie
        * @param api-version
        */
	 facebookProvider.setInitParams('your-fb-app-id',true,true,true,'v2.1');
	 //if your app use extra permissions set it
	 facebookProvider.setPermissions(['email','read_stream']);
      });

Important: You must include the JS SDK in your <head> or in method .run(function(){}) of angular app. Not necessary from version 0.1.2

##Usage

The provider permits to have an easy access to the most used api (like user info retriving, avatar, etc..) but it also permits, thanks to api method, to used all methods of Graph API.

Every methods check the login status and if user isn't logged, it launches the login procedure. Anyway the provider has public methods login and checkLoginStatus to implement your custom flows.

Check SDK Loading

In your controller listen on the $rootScope the event fb.init

module.controller('MainCtrl', function ($rootScope,$scope, facebook) {
	$rootScope.$on("fb.init",function(){
	    console.log("SDK Ready");
	});
});

Run the method

Run the method that you need. For instance: getUser to obtain available user information.

module.controller('MainCtrl', function ($rootScope,$scope, facebook) {
	$rootScope.$on("fb.init",function(){
	    console.log("SDK Ready");
	    facebook.getUser().then(function(r){
	    	console.log(r.user); //User data returned;
	    	console.log(r.authResponse); //Token auth, id etc..
	    }, function(err){
	    	console.log("Ops, something went wrong...");
	    });
	    
	});
});

###Documentation

The official docs wiki is here

Enum

  • API_METHOD | The HTTP method that you can use to call the api.
  • PICTURE_TYPE | When you get user profile image use this to indicate a pre-specified size of picture.

Method

##Versions & Changelog

0.1.2

Bug Fixing:

  • In checkLoginStatus you can now choose if force login or not

  • Added integration with async FB SDK loading (you don't have to load manually the sdk)

0.1.1

Bug fixing:

0.1.0

First stable version.

Next Version

Version: 0.2.0

  • Minor bug fixing
  • New easy method:
    • getUserFeed() -> It fetches user feed post.
    • uploadPhoto() -> It permits to upload a photo from form or url.
    • createPost() -> It permits to post on user's feed.
  • New configuration method:
    • Disable/enabled autologin

License

This project is released over MIT license

Author

Lorenzo Bertacchi