FacebookT auth m a is this library's monad transformer. Contains information needed to issue commands and queries to Facebook. The phantom type auth may be either Auth (you have supplied your Credentials) or NoAuth (you have not supplied any Credentials).

Run a computation in the FacebookT monad transformer with your credentials.

Run a computation in the FacebookT monad without credentials.

Transform the computation inside a FacebookT.

Same as runFacebookT, but uses Facebook's beta tier (see https://developers.facebook.com/support/beta-tier/).

Same as runNoAuthFacebookT, but uses Facebook's beta tier (see https://developers.facebook.com/support/beta-tier/).

Phantom type stating that you have provided your Credentials and thus have access to the whole API.

Phantom type stating that you have not provided your Credentials. This means that you'll be limited about which APIs you'll be able use.

Credentials that you get for your app when you register on Facebook.

An access token. While you can make some API calls without an access token, many require an access token and some will give you more information with an appropriate access token.

There are two kinds of access tokens:

User access token

An access token obtained after an user accepts your application. Let's you access more information about that user and act on their behalf (depending on which permissions you've asked for).

App access token

An access token that allows you to take administrative actions for your application.

These two kinds of access tokens are distinguished by the phantom type on AccessToken, which can be UserKind or AppKind.

Type synonym for AccessToken UserKind.

Type synonym for AccessToken AppKind.

The access token data that is passed to Facebook's API calls.

True if the access token has expired, otherwise False.

True if the access token is valid. An expired access token is not valid (see hasExpired). However, a non-expired access token may not be valid as well. For example, in the case of an user access token, they may have changed their password, logged out from Facebook or blocked your app.

Phantom type used mark an AccessToken as an app access token.

Get an app access token from Facebook using your credentials.

Phantom type used mark an AccessToken as an user access token.

URL where the user is redirected to after Facebook authenticates the user authorizes your application. This URL should be inside the domain registered for your Facebook application.

A permission that is asked for the user when he authorizes your app. Please refer to Facebook's documentation at https://developers.facebook.com/docs/reference/api/permissions/ to see which permissions are available.

This is a newtype of Text that supports only IsString. This means that to create a Permission you should use the OverloadedStrings language extension. For example,

 {-# LANGUAGE OverloadedStrings #-}

 perms :: [Permission]
 perms = ["user_about_me", "email", "offline_access"]

The first step to get an user access token. Returns the Facebook URL you should redirect you user to. Facebook will authenticate the user, authorize your app and then redirect the user back into the provider RedirectUrl.

The second step to get an user access token. If the user is successfully authenticate and they authorize your application, then they'll be redirected back to the RedirectUrl you've passed to getUserAccessTokenStep1. You should take the request query parameters passed to your RedirectUrl and give to this function that will complete the user authentication flow and give you an UserAccessToken.

The URL an user should be redirected to in order to log them out of their Facebook session. Facebook will then redirect the user to the provided URL after logging them out. Note that, at the time of this writing, Facebook's policies require you to log the user out of Facebook when they ask to log out of your site.

Note also that Facebook may refuse to redirect the user to the provided URL if their user access token is invalid. In order to prevent this bug, we suggest that you use isValid before redirecting the user to the URL provided by getUserLogoutUrl since this function doesn't do any validity checks.

Extend the expiration time of an user access token (see https://developers.facebook.com/docs/offline-access-deprecation/, https://developers.facebook.com/roadmap/offline-access-removal/). Only short-lived user access tokens may extended into long-lived user access tokens, you must get a new short-lived user access token if you need to extend a long-lived one. Returns Left exc if there is an error while extending, or Right token with the new user access token (which could have the same data and expiration time as before, but you can't assume this). Note that expired access tokens can't be extended, only valid tokens.

Get detailed information about an access token.

Detailed information about an access token (cf. debugToken).

Parses a Facebook signed request (https://developers.facebook.com/docs/authentication/signed_request/), verifies its authencity and integrity using the HMAC and decodes its JSON object.

A Facebook user profile (see https://developers.facebook.com/docs/reference/api/user/).

NOTE: We still don't support all fields supported by Facebook. Please fill an issue if you need access to any other fields.

A Facebook user ID such as 1008905713901.

An user's gender.

Get an user using his user ID. The user access token is optional, but when provided more information can be returned back by Facebook. The user ID may be "me", in which case you must provide an user access token and information about the token's owner is given.

Search users by keyword.

Get a list of check-ins made by a given user.

A friend connection of a User.

Get the list of friends of the given user.

A Facebook page (see https://developers.facebook.com/docs/reference/api/page/).

NOTE: Does not yet support all fields. Please file an issue if you need any other fields.

Get a page using its ID. The user access token is optional.

Search pages by keyword. The user access token is optional.

An action of your app. Please refer to Facebook's documentation at https://developers.facebook.com/docs/opengraph/keyconcepts/#actions-objects to see how you can create actions.

This is a newtype of Text that supports only IsString. This means that to create an Action you should use the OverloadedStrings language extension. For example,

 {-# LANGUAGE OverloadedStrings #-}

 foo token = do
   ...
   createAction "cook" [...] token

Creates an Open Graph action on the user's timeline. Returns the Id of the newly created action. For example:

 now <- liftIO getCurrentTime
 createAction "cook"
              [ "recipe" #= "http://example.com/cookie.html"
              , "when"   #= now ]
              token

A Facebook check-in (see https://developers.facebook.com/docs/reference/api/checkin/).

NOTE: We still don't support all fields supported by Facebook. Please fill an issue if you need access to any other fields.

Information about the user who made the check-in.

Get a checkin from its ID. The user access token is optional, but when provided more information can be returned back by Facebook.

Creates a 'check-in' and returns its ID. Place and coordinates are both required by Facebook.

A Facebook Order oject.

Order Id type.

A trimmed down version of Facebook Application as it is used in Order.

A Facebook Order status type.

Get an Order using its OrderId. The user access token is mandatory.

Create an Argument with a SimpleType. See the docs on createAction for an example.

Class for data types that may be represented as a Facebook simple type. (see https://developers.facebook.com/docs/opengraph/simpletypes/).

newtype for UTCTime that follows Facebook's conventions of JSON parsing.

• As a string, while aeson expects a format of %FT%T%Q, Facebook gives time values formatted as %FT%T%z.
• As a number, FbUTCTime accepts a number of seconds since the Unix epoch.

Information about a place. This is not a Graph Object, instead it's just a field of a Object. (Not to be confused with the Page object.)

A geographical location.

Geographical coordinates.

A tag (i.e. "I'll tag you on my post").

Many Graph API results are returned as a JSON object with the following structure:

 {
   "data": [
     ...item 1...,
          :
     ...item n...
   ],
   "paging": {
     "previous": "http:...link to previous page...",
     "next":     "http:...link to next page..."
   }
 }

Only the "data" field is required, the others may or may not appear.

A Pager a datatype encodes such result where each item has type a. You may use functions fetchNextPage and fetchPreviousPage to navigate through the results.

Tries to fetch the next page of a Pager. Returns Nothing whenever the current Pager does not have a pagerNext.

Tries to fetch the previous page of a Pager. Returns Nothing whenever the current Pager does not have a pagerPrevious.

Tries to fetch all next pages and returns a Source with all results. The Source will include the results from this page as well. Previous pages will not be considered. Next pages will be fetched on-demand.

Tries to fetch all previous pages and returns a Source with all results. The Source will include the results from this page as well. Next pages will not be considered. Previous pages will be fetched on-demand.

Add or modify a subscription for real-time updates. If there were no previous subscriptions for the given RealTimeUpdateObject, then a new subscription is created. If there was any previous subscription for the given RealTimeUpdateObject, it's overriden by this one (even if the other subscription had a different callback URL).

List current real-time update subscriptions.

The type of objects that a real-time update refers to.

A field of a RealTimeUpdateObject that you would like to receive notifications when changed.

The URL on your server that will receive the real-time updates. Please refer to Facebook's documentation in order to see what this URL needs to implement.

A token that is sent back by Facebook's servers to your server in order to verify that you really were trying to modify your subscription.

Information returned by Facebook about a real-time update notification subscription.

Verifies the input's authenticity (i.e. it comes from Facebook) and integrity by calculating its HMAC-SHA1 (using your application secret as the key) and verifying that it matches the value from the HTTP request's X-Hub-Signature header's value. If it's not valid, Nothing is returned, otherwise Just data is returned where data is the original data.

Same as verifyRealTimeUpdateNotifications but also parses the response as JSON. Returns Nothing if either the signature is invalid or the data can't be parsed (use verifyRealTimeUpdateNotifications if you need to distinguish between these two error conditions).

When data changes and there's a valid subscription, Facebook will POST to your RealTimeUpdateUrl with a JSON-encoded object containing the notifications. A 'RealTimeUpdateNotification a' represents such object where a is type of the entries (e.g., RealTimeUpdateNotificationUserEntry).

If you have a single RealTimeUpdateUrl for different kinds of notifications, you may parse a RealTimeUpdateNotification Value and then manually parse the Value depending on the value of rtunObject.

We recommend using getRealTimeUpdateNotifications.

A notification for the UserRTUO object.

Query the Facebook Graph using FQL.

newtype wrapper around UTCTime that is able to parse FQL's time representation as seconds since the Unix epoch.

newtype wrapper around lists that works around FQL's strange lists.

For example, if you fetch the tagged_uids field from location_post, you'll find that Facebook's FQL represents an empty list of tagged UIDs as plain JSON array ([]). However, it represents a singleton list as an object {"1234": 1234} instead of the much more correct [1234].

On the other hand, not all FQL arrays are represented in this bogus manner. Also, some so-called arrays by FQL's documentation are actually objects, see FQLObject.

newtype wrapper around any object that works around FQL's strange objects.

For example, if you fetch the app_data field from stream, you'll find that empty objects are actually represented as empty lists [] instead of a proper empty object {}. Also note that FQL's documentation says that app_data is an array, which it clear is not. See also FQLList.

Get a list of test users.

Remove an existing test user.

Create a new test user.

Make a friend connection between two test users.

This is how Facebook's API work: two calls must be made. The first call has the format: "/userA_id/friends/userB_id" with the access token of user A as query parameter. The second call has the format: "/userB_id/friends/userA_id" with the access token of user B as query parameter. The first call creates a friend request and the second call accepts the friend request.

Create an UserAccessToken from a TestUser. It's incomplete because it will not have the right expiration time.

A Facebook test user.

Data type used to hold information of a new test user. This type also accepts a Data.Default value.

Specify if the app is to be installed on the new test user. If it is, then you must tell what permissions should be given.

Make a raw GET request to Facebook's Graph API.

Make a raw POST request to Facebook's Graph API.

Make a raw DELETE request to Facebook's Graph API.

Make a raw GET request to the /search endpoint of Facebook’s Graph API. Returns a raw JSON Value.

The identification code of an object.

An argument given to an API call.

An exception that may be thrown by functions on this package. Includes any information provided by Facebook.

Retrieves the Text back from a Permission. Most of the time you won't need to use this function, but you may need it if you're a library author.