@ionic-native/facebook

property EVENTS

EVENTS: {
    EVENT_NAME_ACTIVATED_APP: string;
    EVENT_NAME_DEACTIVATED_APP: string;
    EVENT_NAME_SESSION_INTERRUPTIONS: string;
    EVENT_NAME_TIME_BETWEEN_SESSIONS: string;
    EVENT_NAME_COMPLETED_REGISTRATION: string;
    EVENT_NAME_VIEWED_CONTENT: string;
    EVENT_NAME_SEARCHED: string;
    EVENT_NAME_RATED: string;
    EVENT_NAME_COMPLETED_TUTORIAL: string;
    EVENT_NAME_PUSH_TOKEN_OBTAINED: string;
    EVENT_NAME_ADDED_TO_CART: string;
    EVENT_NAME_ADDED_TO_WISHLIST: string;
    EVENT_NAME_INITIATED_CHECKOUT: string;
    EVENT_NAME_ADDED_PAYMENT_INFO: string;
    EVENT_NAME_PURCHASED: string;
    EVENT_NAME_ACHIEVED_LEVEL: string;
    EVENT_NAME_UNLOCKED_ACHIEVEMENT: string;
    EVENT_NAME_SPENT_CREDITS: string;
    EVENT_PARAM_CURRENCY: string;
    EVENT_PARAM_REGISTRATION_METHOD: string;
    EVENT_PARAM_CONTENT_TYPE: string;
    EVENT_PARAM_CONTENT_ID: string;
    EVENT_PARAM_SEARCH_STRING: string;
    EVENT_PARAM_SUCCESS: string;
    EVENT_PARAM_MAX_RATING_VALUE: string;
    EVENT_PARAM_PAYMENT_INFO_AVAILABLE: string;
    EVENT_PARAM_NUM_ITEMS: string;
    EVENT_PARAM_LEVEL: string;
    EVENT_PARAM_DESCRIPTION: string;
    EVENT_PARAM_SOURCE_APPLICATION: string;
    EVENT_PARAM_VALUE_YES: string;
    EVENT_PARAM_VALUE_NO: string;
};

method activateApp

activateApp: () => Promise<any>;

• Manually log activation events

  Returns

  {Promise}

method api

api: (
    requestPath: string,
    permissions: string[],
    httpMethod?: string
) => Promise<any>;

• Make a call to Facebook Graph API. Can take additional permissions beyond those granted on login.

  For more information see:

  Calling the Graph API - https://developers.facebook.com/docs/javascript/reference/FB.api Graph Explorer - https://developers.facebook.com/tools/explorer Graph API - https://developers.facebook.com/docs/graph-api

  Parameter requestPath

  Graph API endpoint you want to call

  Parameter permissions

  List of [permissions](https://developers.facebook.com/docs/facebook-login/permissions) for this request.

  Parameter httpMethod

  HTTP method for the request, one of "GET", "POST", or "DELETE" (default is "GET")

  Returns

  {Promise} Returns a Promise that resolves with the result of the request, or rejects with an error

method checkHasCorrectPermissions

checkHasCorrectPermissions: (permissions: string[]) => Promise<string>;

• Check if the user has approved all necessary permissions

  Parameter permissions

  List of [permissions](https://developers.facebook.com/docs/facebook-login/permissions) to check for

  Returns

  {Promise} Returns a Promise that resolves with a success string if all passed permissions are granted, or an error string if any permissions are not granted

method getAccessToken

getAccessToken: () => Promise<string>;

• Get a Facebook access token for using Facebook services.

  Returns

  {Promise} Returns a Promise that resolves with an access token, or rejects with an error

method getApplicationId

getApplicationId: () => Promise<string>;

• Get the current application ID

  Returns

  {Promise} Returns a Promise that resolves with the current application ID

method getApplicationName

getApplicationName: () => Promise<string>;

• Get the current application name

  Returns

  {Promise} Returns a Promise that resolves with the current application name

method getCurrentProfile

getCurrentProfile: () => Promise<any>;

• Get profile information for the currently logged in user

  Returns

  {Promise} Returns a Promise that resolves with success data, or rejects with an error

method getDeferredApplink

getDeferredApplink: () => Promise<string>;

• Returns the deferred app link

  Returns

  {Promise}

method getLoginStatus

getLoginStatus: () => Promise<any>;

• Determine if a user is logged in to Facebook and has authenticated your app. There are three possible states for a user:

  1) the user is logged into Facebook and has authenticated your application (connected) 2) the user is logged into Facebook but has not authenticated your application (not_authorized) 3) the user is either not logged into Facebook or explicitly logged out of your application so it doesn't attempt to connect to Facebook and thus, we don't know if they've authenticated your application or not (unknown)

  Resolves with a response like:

  {
    authResponse: {
      userID: '12345678912345',
      accessToken: 'kgkh3g42kh4g23kh4g2kh34g2kg4k2h4gkh3g4k2h4gk23h4gk2h34gk234gk2h34AndSoOn',
      data_access_expiration_time: '1623680244',
      expiresIn: '5183738'
    },
    status: 'connected'
  }

  For more information see the [Facebook docs](https://developers.facebook.com/docs/reference/javascript/FB.getLoginStatus)

  Returns

  {Promise} Returns a Promise that resolves with a status, or rejects with an error

method isDataAccessExpired

isDataAccessExpired: () => Promise<string>;

• Check if data access has expired for the user

  Returns

  {Promise} Returns a Promise that resolves with a success string if data access is expired, or rejects with an error

method logEvent

logEvent: (name: string, params?: Object, valueToSum?: number) => Promise<any>;

• Log an event. For more information see the Events section above.

  Parameter name

  Name of the event

  Parameter params

  An object containing extra data to log with the event

  Parameter valueToSum

  any value to be added to added to a sum on each event

  Returns

  {Promise}

method login

login: (permissions: string[]) => Promise<FacebookLoginResponse>;

• Login to Facebook to authenticate this app.

  {
    status: 'connected',
    authResponse: {
      accessToken: 'kgkh3g42kh4g23kh4g2kh34g2kg4k2h4gkh3g4k2h4gk23h4gk2h34gk234gk2h34AndSoOn',
      data_access_expiration_time: '1623680244',
      expiresIn: 5183979,
      userID: '634565435'
    }
  }

  Parameter permissions

  List of [permissions](https://developers.facebook.com/docs/facebook-login/permissions) this app has upon logging in.

  Returns

  {Promise} Returns a Promise that resolves with a status object if login succeeds, and rejects if login fails.

method loginWithLimitedTracking

loginWithLimitedTracking: (
    permissions: string[]
) => Promise<FacebookLoginResponse>;

• Login to Facebook using Limited Login (iOS Only)

  {
    status: 'connected',
    authResponse: {
      authenticationToken: 'kgkh3g42kh4g23kh4g2kh34g2kg4k2h4gkh3g4k2h4gk23h4gk2h34gk234gk2h34AndSoOn',
      nonce: 'foo',
      userID: '634565435'
    }
  }

  Parameter permissions

  List of [permissions](https://developers.facebook.com/docs/facebook-login/limited-login/permissions) this app has upon logging in.

  Returns

  {Promise} Returns a Promise that resolves with a status object if login succeeds, and rejects if login fails.

method logout

logout: () => Promise<any>;

• Logout of Facebook.

  For more info see the [Facebook docs](https://developers.facebook.com/docs/reference/javascript/FB.logout)

  Returns

  {Promise} Returns a Promise that resolves on a successful logout, and rejects if logout fails.

method logPurchase

logPurchase: (value: number, currency: string, params?: Object) => Promise<any>;

• Log a purchase. For more information see the Events section above.

  Parameter value

  Value of the purchase.

  Parameter currency

  The currency, as an [ISO 4217 currency code](http://en.wikipedia.org/wiki/ISO_4217)

  Parameter params

  An object containing extra data to log with the event

  Returns

  {Promise}

method reauthorizeDataAccess

reauthorizeDataAccess: () => Promise<FacebookLoginResponse>;

• Reauthorize data access after it has expired

  Returns

  {Promise} Returns a Promise that resolves with a status object if login succeeds, and rejects if login fails.

method setAdvertiserIDCollectionEnabled

setAdvertiserIDCollectionEnabled: (enabled: boolean) => Promise<void>;

• Enable or disable collection of advertiser-id

  Parameter enabled

  value to be set

method setAdvertiserTrackingEnabled

setAdvertiserTrackingEnabled: (enabled: boolean) => Promise<void>;

• Enable or disable advertiser tracking (iOS Only)

  Parameter enabled

  value to be set

method setApplicationId

setApplicationId: (id: string) => Promise<void>;

• Set the application ID

  Parameter id

  application ID

method setApplicationName

setApplicationName: (name: string) => Promise<void>;

• Set the application name

  Parameter name

  application name

method setAutoLogAppEventsEnabled

setAutoLogAppEventsEnabled: (enabled: boolean) => Promise<void>;

• Enable or disable the auto log app event feature - https://developers.facebook.com/docs/app-events/gdpr-compliance/

  Parameter enabled

  value to be set

method showDialog

showDialog: (options: any) => Promise<any>;

• Show one of various Facebook dialogs. Example of options for a Share dialog:

  {
    method: 'share',
    href: 'http://example.com',
    caption: 'Such caption, very feed.',
    description: 'Much description',
    picture: 'http://example.com/image.png'
  }

  For more options see the [Cordova plugin docs](https://github.com/cordova-plugin-facebook-connect/cordova-plugin-facebook-connect#show-a-dialog) and the [Facebook docs](https://developers.facebook.com/docs/javascript/reference/FB.ui)

  Parameter options

  The dialog options

  Returns

  {Promise} Returns a Promise that resolves with success data, or rejects with an error

property authResponse

authResponse: {
    accessToken: string;
    data_access_expiration_time: string;
    expiresIn: number;
    userID: string;
};

property status

status: string;