cordova-facebook

Cordova plugin that handles Facebook integration for mobile (iOS and Android) apps.

Project uses mobile native platform FacebookSDK for iOS and Android to utilize basic operations for a mobile app that uses Cordova.

We also provide TypeScript source file together with the JavaScript for the client side with this plugin.

##Why?

• Why do we implement another plugin since there is already an official phonegap-facebook-plugin?
  1. As of today (16.01.2014), official cordova facebook plugin project on GitHub has 985 stars (including mine), 118 watchers, 218 open issues, 29 pull requests and 5 branches.
  2. Last commit as of today to master branch was 3 months ago, we don't have time to wait for fixes and new updates.
  3. Official plugin tries to retain the same interface for the Facebook JavaScript SDK, which we believe an unnecessary burden.
  4. We have some live apps that uses the official plugin, and we are scared to update our app to new Cordova version, scared to break things in Facebook side.
  5. Well, it was not that hard to do it, so we did it.

##Versions We support only Cordova version > 3.0

We currently tested FacebookSDK for following platforms and versions:

• FacebookSDK iOS 3.13.1

• FacebookSDK Android 3.8

##Prerequisites

###iOS Download the latest FacebookSDK, and follow the getting started guideline.

The guideline is well documented and people at Facebook may change stuff in the future, so we stick to that instead of fancy cordova plugin hacks (well, cordova people also modify plugin flow too).

###Android

Unlike iOS, Android getting started guideline is pretty long and scary. For Android we rely on Android Simple Facebook by Roman Kushnarenko, many thanks for that project. We are using our own fork (but it's in sync for now) for this plugin. We distribute the compiled version of the library with the plugin, so you don't have to worry about anything.

Here is what to do for Android before installing our plugin.

1. Clone Facebook SDK 3.6 or download it. Then, import the project to your workspace.

2. Add reference from your project to FacebookSDK project.

   

##Installing the plugin To add this plugin just type: cordova plugin add https://github.com/ccsoft/cordova-facebook.git

To remove this plugin type: cordova plugin remove com.ccsoft.plugin.CordovaFacebook

##Usage Add the following block to your AppDelegate.m

// During the Facebook login flow, your app passes control to the Facebook iOS app or Facebook in a mobile browser.
// After authentication, your app will be called back with the session information.
- (BOOL)application:(UIApplication *)application
        openURL:(NSURL *)url
sourceApplication:(NSString *)sourceApplication
     	annotation:(id)annotation
{
	NSMutableDictionary *dict = [NSMutableDictionary dictionaryWithObjectsAndKeys:
                      url, @"url", sourceApplication, @"sourceApplication", @"NO", @"success", nil];
	[[NSNotificationCenter defaultCenter] postNotification:[NSNotification notificationWithName:@"CordovaPluginOpenURLNotification" object:self userInfo:dict]];

	NSString* success = [dict objectForKey:@"success"];
	return ![success isEqualToString:@"NO"];
}

Then, in your js file (probably in index.js)

// Get a reference to the plugin first
var plugin = new CC.CordovaFacebook();

The plugin has the following methods:

• init
• login
• logout
• info
• share
• feed
• invite

---

###init Initializes the plugin. Must be called before calling any other function.

####parameters

appId: string: Your FB app id.

appName: string: Your FB app name.

appPermissions: array: Your FB app permissions as an array of strings.

successCallback: function: If not already logged in, we return an empty string. If already logged in to FB we return JSONObject for "accessToken", "expirationDate" and "permissions". Expiration date is a timestamp value. Permissions are retruned as JSONArray.

failureCallback: function: Called with failure reason string.

####example

plugin.init('YOUR_FB_APP_ID', 'YOUR_FB_APP_NAME', 
	['basic_info', 'email', 'publish_actions'], 
	function(response) {
		if(response) {
			console.log("Access token is: " + response.accessToken);
			console.log("Expires: " + response.expirationDate);
			console.log("Permissions are: " + response.permissions);
		}
}), failureCallback);

---

###login

####parameters

successCallback: function: Called with a JSONObject for "accessToken", "expirationDate" and "permissions". Expiration date is a timestamp value. Permissions are retruned as JSONArray.

failureCallback: function: Called with failure reason string.

####example

plugin.login(function(response) {
	console.log("Access token is: " + response.accessToken);
	console.log("Expires: " + response.expirationDate);
	console.log("Permissions are: " + response.permissions);
}), failureCallback);

---

###logout

####parameters

successCallback: function: Called with no params.

####example

plugin.logout(successCallback);

---

###info Retrieves user info. See FBGraphUser documentation for successCallback parameter in iOS. See the example below for Android. (They must be equiavelent, let us know if there are differences.)

####parameters

successCallback: function: Called with user info data

failureCallback: function: Called with failure reason string.

####example

plugin.info(function(data) {
	console.log("User Id: "		+ data.id);
	console.log("Name: "			+ data.name);
	console.log("Email: "		+ data.email); // if asked for it in permissions
	console.log("First Name: "	+ data.first_name);
	console.log("Last Name: "	+ data.last_name);
	console.log("Link: "			+ data.link);
	console.log("Locale: "		+ data.locale);
}, 
function(err) {console.log(err););

---

###share

• iOS: share call tries to open share dialog via official Facebook app. If Facebook app is not installed on device, we fallback to feed call.
• Android: share behaves exactly the same as feed.

####parameters

name: string

url: string

logoUrl: string

caption: string

description: string

successCallback: function: post_id (on iOS, if Facebook app is installed and used for share, pass no parameters to callback on success)

failureCallback: function: Called with failure reason string.

####example

plugin.share('Name', 'http://www.example.com', 'http://www.example.com/test.png', 
	'Test caption', 'Test description.', successCallback, failureCallback);

---

###feed feed call requires an active session. Shows facebook web dialog as a popup on iOS and uses open graph on Android. On Android, we will support dialog whem Simple Facebook library supports it.

####parameters

name: string

url: string

logoUrl: string

caption: string

description: string

successCallback: function: post_id (on iOS, if Facebook app is installed and used for share, pass no parameters to callback on success)

failureCallback: function: Called with failure reason string.

####example

plugin.feed('Name', 'http://www.example.com', 'http://www.example.com/test.png', 
	'Test caption', 'Test description.', successCallback, failureCallback);

---

###invite invite call requires an active session. Shows facebook invite dialog and returns the invitation response.

####parameters

message: string: Mesage to be shown with the invitation (to friend).

title: string: Title to be shown with the invitation (to friend).

successCallback: function: Returns invitation id and the fb id of people the invitation has been sent.

failureCallback: function: Called with failure reason string.

####example

plugin.invite('Invitation message better be inviting', 'Invitation Title', successCallback, failureCallback);

For implementation details:

• See iOS documentation here
• See Android implementation details here

---

##Sample App We have a sample cordova app to test the plugin that you can find here. Please note that the link takes you to a dedicated branch named facebook, please use that branch to test this plugin. We use separate branches for each plugin we implement.

Once you download/clone and run the app, you are going to be using a sample Facebook app in sandbox. You can change your app settings (in index.html), you can also test the features with the following Facebook tester user credentials:

User: [email protected]

Pass: 123456

##License Apache 2.0 License