/ng2-facebook-sdk

Angular 2 TypeScript Wrapper for Facebook SDK

Primary LanguageTypeScriptMIT LicenseMIT

npm

NPM

Angular2 Facebook SDK

This is a wrapper for the official Facebook JavaScript SDK. You must still include their JavaScript files in your project. This wrapper makes it easier to use Facebook SDK with Angular2 by providing types and promises.

Installation

Install via NPM:

npm i --save-dev ng2-facebook-sdk

Install via Bower:

bower install ng2-facebook-sdk

Example Usage

import {FacebookService, FacebookLoginResponse} from 'ng2-facebook-sdk/dist';

@Component({
  templateUrl: '/path/to/template.html',
  providers: [FacebookService]
})
export class MyComponent {
  constructor(private fb: FacebookService) { }

  someFunction(): void {
    this.fb.login().then(
      (response: FacebookLoginResponse) => console.log(response),
      (error: any) => console.error(error)
    );
  }
}

Methods

init(params: FacebookInitParams): void

This method is used to initialize and setup the SDK.

import {FacebookService, FacebookInitParams} from 'ng2-facebook-sdk/dist';

@Component(...)
export class MyComponent {
  constructor(private fb: FacebookService) {
    let fbParams: FacebookInitParams = {
                                   appId: '1234566778',
                                   xfbml: true,
                                   version: 'v2.6'
                                   };
    this.fb.init(fbParams);
  }
}
import {FacebookService, FacebookInitParams} from 'ng2-facebook-sdk/dist';

@Component(...)
export class MyComponent {
  
}

Interfaces

FacebookInitParams

Name Type Description
appId string Your application ID. If you don't have one find it in the App dashboard or go there to create a new app. Defaults to null.
version string Determines which versions of the Graph API and any API dialogs or plugins are invoked when using the .api() and .ui() functions. Valid values are determined by currently available versions, such as 'v2.0'. This is a required parameter.
cookie boolean Determines whether a cookie is created for the session or not. If enabled, it can be accessed by server-side code. Defaults to false.
status boolean Determines whether the current login status of the user is freshly retrieved on every page load. If this is disabled, that status will have to be manually retrieved using .getLoginStatus(). Defaults to false.
xfbml boolean Determines whether XFBML tags used by social plugins are parsed, and therefore whether the plugins are rendered or not. Defaults to false.
frictionlessRequests boolean Frictionless Requests are available to games on Facebook.com or on mobile web using the JavaScript SDK. This parameter determines whether they are enabled. Defaults to false.
hideFlashCallback function This specifies a function that is called whenever it is necessary to hide Adobe Flash objects on a page. This is used when .api() requests are made, as Flash objects will always have a higher z-index than any other DOM element. See our Custom Flash Hide Callback for more details on what to put in this function. Defaults to null.

FacebookApiMethod (enum)

Name Description
get Get request
post Post request
delete Delete request

FacebookUiParams

FacebookAuthResponse

Name Type Description
accessToken string User access token
expiresIn number Access token lifetime in seconds
signedRequest string
userID string The Facebook user ID

FacebookLoginStatus

Name Type Description
status string Status
authResponse FacebookAuthResponse Facebook AuthResponse object

FacebookLoginOptions

Name Type Description
auth_type string
scope string
return_scopes boolean
enable_profile_selector boolean
profile_selector_ids string

FacebookLoginResponse

Name Type Description
authResponse FacebookAuthResponse
status string