org.mule.modules

mule-module-facebook

config-with-oauth

Namespace	http://www.mulesoft.org/schema/mule/facebook
Schema Location	http://www.mulesoft.org/schema/mule/facebook/current/mule-facebook.xsd (View Schema)
Schema Version	2.0
Minimum Mule Version	3.4

Module Overview

Facebook is a social networking service and website launched in February 2004.

Summary

Configuration
<facebook:config-with-oauth> Configure an instance of this module

Message Processors
<facebook:attend-event> Attend the given event.
<facebook:decline-event> Decline the given event.
<facebook:delete-object> Delete an object in the graph.
<facebook:dislike> Remove a 'like' from a post.
<facebook:download-image> This is a convinience processor that simply fetchs an uri which is expected to return an image and returns it as a Byte array.
<facebook:get-album> A photo album
<facebook:get-album-comments> The comments made on this album
<facebook:get-album-photos> The photos contained in this album
<facebook:get-application> An application's profile
<facebook:get-application-albums> The photo albums this application has created.
<facebook:get-application-events> The events this page is managing
<facebook:get-application-insights> Usage metrics for this application
<facebook:get-application-links> The application's posted links.
<facebook:get-application-notes> The application's notes.
<facebook:get-application-photos> The photos this application is tagged in.
<facebook:get-application-picture> The application's logo
<facebook:get-application-statuses> The application's status updates.
<facebook:get-application-tagged> The photos, videos, and posts in which this application has been tagged.
<facebook:get-application-videos> The videos this application has created
<facebook:get-application-wall> The application's wall.
<facebook:get-checkin> A check-in that was made through Facebook Places.
<facebook:get-event> Specifies information about an event, including the location, event name, and which invitees plan to attend.
<facebook:get-event-attending> All of the users who are attending this event
<facebook:get-event-declined> All of the users who declined their invitation to this event
<facebook:get-event-invited> All of the users who have been invited to this event
<facebook:get-event-maybe> All of the users who have been responded "Maybe" to their invitation to this event
<facebook:get-event-no-reply> All of the users who have been not yet responded to their invitation to this event
<facebook:get-event-picture> The event's profile picture
<facebook:get-event-wall> This event's wall
<facebook:get-group> A Facebook group
<facebook:get-group-members> All of the users who are members of this group
<facebook:get-group-picture> The profile picture of this group
<facebook:get-group-wall> This group's wall
<facebook:get-link> A link shared on a user's wall
<facebook:get-link-comments> All of the comments on this link
<facebook:get-note> A Facebook note
<facebook:get-note-comments> All of the comments on this note
<facebook:get-note-likes> People who like the note
<facebook:get-page> Retrieves the page with the given ID
<facebook:get-page-albums> The photo albums this page has created
<facebook:get-page-checkins> Checkins made by the friends of the current session user
<facebook:get-page-events> The events this page is attending
<facebook:get-page-groups> The groups this page is a member of
<facebook:get-page-links> The page's posted links
<facebook:get-page-notes> The page's notes
<facebook:get-page-photos> The photos this page has uploaded
<facebook:get-page-picture> The page's profile picture
<facebook:get-page-posts> The page's own posts
<facebook:get-page-statuses> The page's status updates
<facebook:get-page-tagged> The photos, videos, and posts in which this page has been tagged
<facebook:get-page-videos> The videos this page has created
<facebook:get-page-wall> The page's wall
<facebook:get-photo> An individual photo
<facebook:get-photo-comments> All of the comments on this photo
<facebook:get-photo-likes> People who like the photo
<facebook:get-post> An individual entry in a profile's feed
<facebook:get-post-comments> All of the comments on this post
<facebook:get-status> A status message on a user's wall
<facebook:get-status-comments> All of the comments on this message
<facebook:get-user> A user profile.
<facebook:get-user-accounts> The Facebook pages owned by the current user
<facebook:get-user-activities> The activities listed on the user's profile
<facebook:get-user-albums> The photo albums this user has created.
<facebook:get-user-books> The books listed on the user's profile
<facebook:get-user-checkins> The music listed on the user's profile
<facebook:get-user-events> The events this user is attending.
<facebook:get-user-friends> The user's friends
<facebook:get-user-groups> The groups this user is a member of.
<facebook:get-user-home> The user's News Feed.
<facebook:get-user-inbox> The threads in this user's inbox.
<facebook:get-user-interests> The interests listed on the user's profile
<facebook:get-user-likes> All the pages this user has liked.
<facebook:get-user-links> The user's posted links.
<facebook:get-user-movies> The movies listed on the user's profile
<facebook:get-user-music> The music listed on the user's profile
<facebook:get-user-notes> The user's notes.
<facebook:get-user-outbox> The messages in this user's outbox.
<facebook:get-user-photos> The photos this user is tagged in.
<facebook:get-user-picture> The user's profile picture
<facebook:get-user-posts> The user's own posts.
<facebook:get-user-search> Search an individual user's News Feed, restricted to that user's friends
<facebook:get-user-statuses> The user's status updates.
<facebook:get-user-tagged> The photos, videos, and posts in which this user has been tagged.
<facebook:get-user-television> The television listed on the user's profile
<facebook:get-user-updates> The updates in this user's inbox.
<facebook:get-user-videos> The videos this user has been tagged in.
<facebook:get-user-wall> The user's wall.
<facebook:get-video> An individual video
<facebook:get-video-comments> All of the comments on this video
<facebook:like> Write to the given profile's feed/wall.
<facebook:logged-user-details> Gets the user logged details.
<facebook:publish-album> Create an album.
<facebook:publish-comment> Comment on the given post
<facebook:publish-event> Post an event in the given profile.
<facebook:publish-link> Write a note on the given profile.
<facebook:publish-message> Write to the given profile's feed/wall.
<facebook:publish-note> Write a note on the given profile.
<facebook:publish-photo> Upload a photo to an album.
<facebook:search-checkins> This request returns you or your friend's latest checkins, or checkins where you or your friends have been tagged; currently, it does not accept a query parameter.
<facebook:search-events> Search over all events in the social graph
<facebook:search-groups> Search over all groups in the social graph
<facebook:search-pages> Search over all pages in the social graph
<facebook:search-posts> Search over all public posts in the social graph
<facebook:search-users> Search over all users in the social graph
<facebook:tentative-event> Maybe attend the given event.

Configuration

To use the this module within a flow the namespace to the module must be included. The resulting flow will look similar to the following:

<mule xmlns="http://www.mulesoft.org/schema/mule/core"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xmlns:facebook="http://www.mulesoft.org/schema/mule/facebook"
      xsi:schemaLocation="
               http://www.mulesoft.org/schema/mule/core
               http://www.mulesoft.org/schema/mule/core/current/mule.xsd
               http://www.mulesoft.org/schema/mule/facebook
               http://www.mulesoft.org/schema/mule/facebook/current/mule-facebook.xsd">

      <!-- here goes your flows and configuration elements -->

</mule>

This module is configured using the config element. This element must be placed outside of your flows and at the root of your Mule application. You can create as many configurations as you deem necessary as long as each carries its own name.

Each message processor, message source or transformer carries a config-ref attribute that allows the invoker to specify which configuration to use.

Attributes
Type	Name	Default Value	Description	Java Type	MIME Type	Encoding
xs:string	name		Optional. Give a name to this configuration so it can be later referenced.
xs:string	appId		The application identifier as registered with Facebook
xs:string	appSecret		The application secret
xs:string	scope	email,read_stream,publish_stream	Optional. Facebook permissions
xs:string	authorizationUrl	https://graph.facebook.com/oauth/authorize	Optional. The URL defined by the Service Provider where the resource owner will be redirected to grant authorization to the connector
xs:string	accessTokenUrl	https://graph.facebook.com/oauth/access_token	Optional. The URL defined by the Service Provider to obtain an access token

OAuth

This connector uses OAuth as an authorization and authentication mechanism with automatic saving and restoring of access tokens. Every message processor in this connector has an extra attribute entitled accessTokenId which is an identification of the user authorizing the conenctor. In order to obtain an access token identification you need to first call the authroize message processor.

Authorizing the connector is a simple process of calling:

    <facebook:authorize/>

The call to authorize message processor must be made from a message coming from an HTTP inbound endpoint as the authorize process will reply with a redirect to the service provider. The following is an example of how to use it in a flow with an HTTP inbound endpoint:

    <flow name="authorizationAndAuthenticationFlow">
        <http:inbound-endpoint host="localhost" port="8080" path="oauth-authorize"/>
        <facebook:authorize/>
    </flow>

If you hit that endpoint via a web-browser it will initiate the OAuth dance, redirecting the user to the service provider page and creating a callback endpoint so the service provider can redirect back once the user has been authenticated and properly authorized the connector. Once the callback gets called then the connector will automatically issue an access token identifier that you need to save as either a cookie or a database record for any subsequent calls.

The authorize message processor also supports the following attributes:

Authorize Attributes
Name	Default Value	Description
authorizationUrl	https://graph.facebook.com/oauth/authorize	Optional. The URL defined by the Service Provider where the resource owner will be redirected to grant authorization to the connector
accessTokenUrl	https://graph.facebook.com/oauth/access_token	Optional. The URL defined by the Service Provider to obtain an access token

After Authorization

The authorize message processor is an intercepting one. If the connector is not authorized yet, it will redirect to the service provider so the user can authorize the connector. This is the reason as to why the authorize needs to be behind and http:inbound-endpoint. The service provider upon successful authentication and authorization then will call back the connector. The connector will extract information from that call, set its internal state to authorized, and then continue execution. Continuing execution means executing everything that was after the authorize whose execution got interrupted because the connector was not authorized.

  <flow name="authorizationAndAuthenticationFlow">
      <http:inbound-endpoint host="localhost" port="8080" path="oauth-authorize"/>
      <facebook:authorize/>
      <http:response-builder status="200">
          <set-payload value="You have successfully authorized the connector"/>
      </http:response-builder>
  </flow>

In the previous example we added the http:response-build (notice that this element is available only in Mule 3.3.0 and later). If the connector is not authorized, the execution of the response builder will be delayed up to the point of the callback execution.

On the other hand if the connector has been authorized and you call authorize again then the flow execution will not stop, it will rather continue and the http:response-builder will get executed right away rather than after the callback.

The following is an example of the authorize message processor, after which it will print the access token identifier to the log:

    <flow name="authorizationAndAuthenticationFlow">
        <http:inbound-endpoint host="localhost" port="8080" path="oauth-authorize"/>
        <facebook:authorize/>
		<log level="INFO" message="The connector has been properly authorized. The access token identifier is #[flowVars['OAuthAccessTokenId']]"/>
    </flow>

The OAuthAccessTokenId flow variable is a special variable available to all the message processors executing after the authorize call. The following snippet shows how you can save it as a HTTP protocol cookie:

    <flow name="authorizationAndAuthenticationFlow">
        <http:inbound-endpoint host="localhost" port="8080" path="oauth-authorize"/>
        <facebook:authorize/>
        <http:response-builder status="200">
            <http:set-cookie name="accessTokenId" value="#[flowVars['OAuthAccessTokenId']]"/>
            <set-payload value="You have successfully authorized the connector. You access token id is #[flowVars['OAuthAccessTokenId']]"/>
        </http:response-builder>
    </flow>

The access token identifier is unique per user and therefore the connector can be authorized for many users. If the user authorizes the connector twice it will have the same access token identifier both times.

Error Handling during Authorization

If for any reason, an errors ocurrs while processing the callback, the exception strategy of the flow containing the authorize will be executed. So, if the callback sent the wrong information you can handle that situation by setting up an exception strategy as follows:

  <flow name="authorizationAndAuthenticationFlow">
      <http:inbound-endpoint host="localhost" port="8080" path="oauth-authorize"/>
      <facebook:authorize/>
      <http:response-builder status="200">
          <set-payload value="You have successfully authorized the connector"/>
      </http:response-builder>
      <catch-exception-strategy>
         <http:response-builder status="404">
             <set-payload value="An error has occurred authorizing the connector"/>
         </http:response-builder>
      </catch-exception-strategy>
  </flow>

Unauthorize

Once this connector has been authorized further calls to the authorize message processor will be no-ops. If you wish to reset the state of the connector back to a non-authorized state you can call:

    <facebook:unauthorize/>

Keep in mind that after the connector is unauthorized all future calls that attempt to access protected resources will fail until the connector is re-authorized.

Callback Customization

As mentioned earlier once authorize gets called and before we redirect the user to the service provider we create a callback endpoint. The callback endpoint will get called automatically by the service provider once the user is authenticated and he grants authorization to the connector to access his private information.

The callback can be customized in the config element of the this connector as follows:

    <facebook:config>
        <facebook:oauth-callback-config domain="${fullDomain}" localPort="10010" remotePort="80"/>
    </facebook:config>

The oauth-callback-config element can be used to customize the endpoint that gets created for the callback. It features the following attributes:

OAuth Callback Config Attributes
Name	Description
connector-ref	Optional. Reference to a user-defined HTTP connector.
domain	Optional. The domain portion of the callback URL. This is usually something like xxx.cloudhub.io if you are deploying to CloudHub for example.
localPort	Optional. The local port number that the endpoint will listen on. Normally 80, in the case of CloudHub you can use the environment variable 10010.
remotePort	Optional. This is the port number that we will tell the service provider we are listening on. It is usually the same as localPort but it is separated in case your deployment features port forwarding or a proxy.
path	Optional. Path under which the callback should be exposed. If not specified a random path will be generated.

The example shown above is what the configuration would look like if your app would be deployed to CloudHub.

Access Token Store

This connector has the capability of automatically saving and restoring access tokens. The connector will store in either the default user object store or a user-defined one the acquired access tokens, refresh tokens, and any other pertinent information using the access token identifier as the key.

The object store can be configured as follows

    <facebook:config>
        <facebook:oauth-store-config objectStore-ref="my-object-store"/>
    </facebook:config>

There is only a single attribute entitled objectStore-ref in the oauth-store-config element that allows the user to specify the name of the object store that he wishes to use to save and restore access tokens.

Message Processors

<facebook:attend-event>

Attend the given event.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
eventId	The id of the event to attend	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId	Access token identifier used to retrieve an access token from the store

<facebook:decline-event>

Decline the given event.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
eventId	Represents the id of the event object	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId	Access token identifier used to retrieve an access token from the store

<facebook:delete-object>

Delete an object in the graph.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
objectId	The ID of the object to be deleted	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId	Access token identifier used to retrieve an access token from the store

<facebook:dislike>

Remove a 'like' from a post.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
postId	The ID of the post to be disliked	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId	Access token identifier used to retrieve an access token from the store

<facebook:download-image>

This is a convinience processor that simply fetchs an uri which is expected to return an image and returns it as a Byte array. Notice that I'm using the word image instead of photo or picture which are words with a particular meaning in facebook. By image, I refer to a generic bitmap.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
imageUri	The uri of an image resource	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId	Access token identifier used to retrieve an access token from the store

Returns

Return Type	Description
byte[]	a byte array with the image

<facebook:get-album>

A photo album

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
album		Represents the ID of the album object.	String	/	UTF-8
metadata	0	Optional. The Graph API supports introspection of objects, which enables you to see all of the connections an object has without knowing its type ahead of time.	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId		Access token identifier used to retrieve an access token from the store

Returns

Return Type	Description
Album	The album

<facebook:get-album-comments>

The comments made on this album

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
album		Represents the ID of the album object.	String	/	UTF-8
since	last week	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
until	yesterday	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
limit	100	Optional. Limit the number of items returned.	String	/	UTF-8
offset	0	Optional. An offset to the response. Useful for paging.	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId		Access token identifier used to retrieve an access token from the store

Returns

Return Type	Description
List<Comment>	response from Facebook

<facebook:get-album-photos>

The photos contained in this album

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
album		Represents the ID of the album object.	String	/	UTF-8
since	last week	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
until	yesterday	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
limit	100	Optional. Limit the number of items returned.	String	/	UTF-8
offset	0	Optional. An offset to the response. Useful for paging.	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId		Access token identifier used to retrieve an access token from the store

Returns

Return Type	Description
List<Photo>	response from Facebook

<facebook:get-application>

An application's profile

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
application	Represents the ID of the application object.	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId	Access token identifier used to retrieve an access token from the store

Returns

Return Type	Description
Application	The application represented by the given id

<facebook:get-application-albums>

The photo albums this application has created.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
application		Represents the ID of the application object.	String	/	UTF-8
since	last week	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
until	yesterday	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
limit	100	Optional. Limit the number of items returned.	String	/	UTF-8
offset	0	Optional. An offset to the response. Useful for paging.	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId		Access token identifier used to retrieve an access token from the store

Returns

Return Type	Description
List<Album>	A list containing the given application's albums

<facebook:get-application-events>

The events this page is managing

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
application		Represents the ID of the application object.	String	/	UTF-8
since	last week	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
until	yesterday	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
limit	100	Optional. Limit the number of items returned.	String	/	UTF-8
offset	0	Optional. An offset to the response. Useful for paging.	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId		Access token identifier used to retrieve an access token from the store

Returns

Return Type	Description
List<Event>	A list containing the events for the given application

<facebook:get-application-insights>

Usage metrics for this application

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
application		Represents the ID of the application object.	String	/	UTF-8
since	last week	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
until	yesterday	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
limit	100	Optional. Limit the number of items returned.	String	/	UTF-8
offset	0	Optional. An offset to the response. Useful for paging.	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId		Access token identifier used to retrieve an access token from the store

Returns

Return Type	Description
List<Insight>	A list containing the insights for the given application

<facebook:get-application-links>

The application's posted links.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
application		Represents the ID of the application object.	String	/	UTF-8
since	last week	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
until	yesterday	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
limit	100	Optional. Limit the number of items returned.	String	/	UTF-8
offset	0	Optional. An offset to the response. Useful for paging.	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId		Access token identifier used to retrieve an access token from the store

Returns

Return Type	Description
List<Post>	A list containig the links of the given application

<facebook:get-application-notes>

The application's notes.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
application		Represents the ID of the application object.	String	/	UTF-8
since	last week	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
until	yesterday	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
limit	100	Optional. Limit the number of items returned.	String	/	UTF-8
offset	0	Optional. An offset to the response. Useful for paging.	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId		Access token identifier used to retrieve an access token from the store

Returns

Return Type	Description
List<Note>	A list containing the notes for the given application

<facebook:get-application-photos>

The photos this application is tagged in.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
application		Represents the ID of the application object.	String	/	UTF-8
since	last week	Optional. A unix timestamp or any date accepted by shorttime	String	/	UTF-8
until	yesterday	Optional. A unix timestamp or any date accepted by shorttime	String	/	UTF-8
limit	100	Optional. Limit the number of items returned.	String	/	UTF-8
offset	0	Optional. An offset to the response. Useful for paging.	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId		Access token identifier used to retrieve an access token from the store

Returns

Return Type	Description
List<Photo>	A list with photos

<facebook:get-application-picture>

The application's logo

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
application		Represents the ID of the application object.	String	/	UTF-8
type	small	Optional. One of square (50x50), small (50 pixels wide, variable height), and large (about 200 pixels wide, variable height)	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId		Access token identifier used to retrieve an access token from the store

Returns

Return Type	Description
byte[]	The given application picture

<facebook:get-application-statuses>

The application's status updates.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
application		Represents the ID of the application object.	String	/	UTF-8
since	last week	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
until	yesterday	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
limit	100	Optional. Limit the number of items returned.	String	/	UTF-8
offset	0	Optional. An offset to the response. Useful for paging.	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId		Access token identifier used to retrieve an access token from the store

Returns

Return Type	Description
List<StatusMessage>	A list containing the status messages for the given application

<facebook:get-application-tagged>

The photos, videos, and posts in which this application has been tagged.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
application		Represents the ID of the application object.	String	/	UTF-8
since	last week	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
until	yesterday	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
limit	100	Optional. Limit the number of items returned.	String	/	UTF-8
offset	0	Optional. An offset to the response. Useful for paging.	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId		Access token identifier used to retrieve an access token from the store

Returns

Return Type	Description
List<GetApplicationTaggedResponseType>	The posts where this application has been tagged

<facebook:get-application-videos>

The videos this application has created

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
application		Represents the ID of the application object.	String	/	UTF-8
since	last week	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
until	yesterday	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
limit	100	Optional. Limit the number of items returned.	String	/	UTF-8
offset	0	Optional. An offset to the response. Useful for paging.	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId		Access token identifier used to retrieve an access token from the store

Returns

Return Type	Description
List<Video>	A list of videos for the given application

<facebook:get-application-wall>

The application's wall.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
application		Represents the ID of the application object.	String	/	UTF-8
since	last week	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
until	yesterday	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
limit	100	Optional. Limit the number of items returned.	String	/	UTF-8
offset	0	Optional. An offset to the response. Useful for paging.	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId		Access token identifier used to retrieve an access token from the store

Returns

Return Type	Description
List<Post>	A list containing the given application posts

<facebook:get-checkin>

A check-in that was made through Facebook Places.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
checkin		Represents the ID of the checkin object.	String	/	UTF-8
metadata	0	Optional. The Graph API supports introspection of objects, which enables you to see all of the connections an object has without knowing its type ahead of time.	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId		Access token identifier used to retrieve an access token from the store

Returns

Return Type	Description
Checkin	The checkin represented by the given id

<facebook:get-event>

Specifies information about an event, including the location, event name, and which invitees plan to attend.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
eventId		Represents the ID of the event object.	String	/	UTF-8
metadata	0	Optional. The Graph API supports introspection of objects, which enables you to see all of the connections an object has without knowing its type ahead of time.	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId		Access token identifier used to retrieve an access token from the store

Returns

Return Type	Description
Event	response from Facebook

<facebook:get-event-attending>

All of the users who are attending this event

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
eventId		Represents the ID of the event object.	String	/	UTF-8
since	last week	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
until	yesterday	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
limit	100	Optional. Limit the number of items returned.	String	/	UTF-8
offset	0	Optional. An offset to the response. Useful for paging.	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId		Access token identifier used to retrieve an access token from the store

Returns

Return Type	Description
List<User>	A list of users

<facebook:get-event-declined>

All of the users who declined their invitation to this event

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
eventId		Represents the ID of the event object.	String	/	UTF-8
since	last week	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
until	yesterday	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
limit	100	Optional. Limit the number of items returned.	String	/	UTF-8
offset	0	Optional. An offset to the response. Useful for paging.	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId		Access token identifier used to retrieve an access token from the store

Returns

Return Type	Description
List<Event>	A list of events

<facebook:get-event-invited>

All of the users who have been invited to this event

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
eventId		Represents the ID of the event object.	String	/	UTF-8
since	last week	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
until	yesterday	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
limit	100	Optional. Limit the number of items returned.	String	/	UTF-8
offset	0	Optional. An offset to the response. Useful for paging.	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId		Access token identifier used to retrieve an access token from the store

Returns

Return Type	Description
List<User>	A list of users

<facebook:get-event-maybe>

All of the users who have been responded "Maybe" to their invitation to this event

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
eventId		Represents the ID of the event object.	String	/	UTF-8
since	last week	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
until	yesterday	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
limit	100	Optional. Limit the number of items returned.	String	/	UTF-8
offset	0	Optional. An offset to the response. Useful for paging.	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId		Access token identifier used to retrieve an access token from the store

Returns

Return Type	Description
List<User>	A list of users

<facebook:get-event-no-reply>

All of the users who have been not yet responded to their invitation to this event

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
eventId		Represents the ID of the event object.	String	/	UTF-8
since	last week	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
until	yesterday	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
limit	100	Optional. Limit the number of items returned.	String	/	UTF-8
offset	0	Optional. An offset to the response. Useful for paging.	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId		Access token identifier used to retrieve an access token from the store

Returns

Return Type	Description
List<User>	A list of users

<facebook:get-event-picture>

The event's profile picture

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
eventId		Represents the ID of the event object.	String	/	UTF-8
type	small	Optional. One of square (50x50), small (50 pixels wide, variable height), and large (about 200 pixels wide, variable height)	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId		Access token identifier used to retrieve an access token from the store

Returns

Return Type	Description
byte[]	The image as a Byte array

<facebook:get-event-wall>

This event's wall

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
eventId		Represents the ID of the event object.	String	/	UTF-8
since	last week	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
until	yesterday	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
limit	100	Optional. Limit the number of items returned.	String	/	UTF-8
offset	0	Optional. An offset to the response. Useful for paging.	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId		Access token identifier used to retrieve an access token from the store

Returns

Return Type	Description
List<Post>	response from Facebook

<facebook:get-group>

A Facebook group

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
group		Represents the ID of the group object.	String	/	UTF-8
metadata	0	Optional. The Graph API supports introspection of objects, which enables you to see all of the connections an object has without knowing its type ahead of time.	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId		Access token identifier used to retrieve an access token from the store

Returns

Return Type	Description
Group	The group represented by the given id

<facebook:get-group-members>

All of the users who are members of this group

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
group		Represents the ID of the group object.	String	/	UTF-8
since	last week	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
until	yesterday	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
limit	100	Optional. Limit the number of items returned.	String	/	UTF-8
offset	0	Optional. An offset to the response. Useful for paging.	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId		Access token identifier used to retrieve an access token from the store

Returns

Return Type	Description
List<Member>	response from Facebook

<facebook:get-group-picture>

The profile picture of this group

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
group		Represents the ID of the group object.	String	/	UTF-8
type	small	Optional. One of square (50x50), small (50 pixels wide, variable height), and large (about 200 pixels wide, variable height)	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId		Access token identifier used to retrieve an access token from the store

Returns

Return Type	Description
byte[]	response from Facebook

<facebook:get-group-wall>

This group's wall

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
group		Represents the ID of the group object.	String	/	UTF-8
since	last week	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
until	yesterday	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
limit	100	Optional. Limit the number of items returned.	String	/	UTF-8
offset	0	Optional. An offset to the response. Useful for paging.	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId		Access token identifier used to retrieve an access token from the store

Returns

Return Type	Description
List<Post>	A list of posts

<facebook:get-link>

A link shared on a user's wall

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
link		Represents the ID of the link object.	String	/	UTF-8
metadata	0	Optional. The Graph API supports introspection of objects, which enables you to see all of the connections an object has without knowing its type ahead of time.	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId		Access token identifier used to retrieve an access token from the store

Returns

Return Type	Description
Link	The link from facebook

<facebook:get-link-comments>

All of the comments on this link

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
link		Represents the ID of the link object.	String	/	UTF-8
since	last week	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
until	yesterday	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
limit	100	Optional. Limit the number of items returned.	String	/	UTF-8
offset	0	Optional. An offset to the response. Useful for paging.	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId		Access token identifier used to retrieve an access token from the store

Returns

Return Type	Description
List<Comment>	A list of comments

<facebook:get-note>

A Facebook note

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
note		Represents the ID of the note object.	String	/	UTF-8
metadata	0	Optional. The Graph API supports introspection of objects, which enables you to see all of the connections an object has without knowing its type ahead of time.	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId		Access token identifier used to retrieve an access token from the store

Returns

Return Type	Description
Note	The note represented by the given id

<facebook:get-note-comments>

All of the comments on this note

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
note		Represents the ID of the note object.	String	/	UTF-8
since	last week	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
until	yesterday	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
limit	100	Optional. Limit the number of items returned.	String	/	UTF-8
offset	0	Optional. An offset to the response. Useful for paging.	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId		Access token identifier used to retrieve an access token from the store

Returns

Return Type	Description
List<Comment>	A list of comments from the given note

<facebook:get-note-likes>

People who like the note

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
note		Represents the ID of the note object.	String	/	UTF-8
since	last week	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
until	yesterday	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
limit	100	Optional. Limit the number of items returned.	String	/	UTF-8
offset	0	Optional. An offset to the response. Useful for paging.	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId		Access token identifier used to retrieve an access token from the store

Returns

Return Type	Description
Post.Likes	The links from the given note

<facebook:get-page>

Retrieves the page with the given ID

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
page		Represents the ID of the page object.	String	/	UTF-8
metadata	0	Optional. The Graph API supports introspection of objects, which enables you to see all of the connections an object has without knowing its type ahead of time.	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId		Access token identifier used to retrieve an access token from the store

Returns

Return Type	Description
Page	The page represented by the given id

<facebook:get-page-albums>

The photo albums this page has created

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
page		Represents the ID of the page object.	String	/	UTF-8
since	last week	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
until	yesterday	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
limit	100	Optional. Limit the number of items returned.	String	/	UTF-8
offset	0	Optional. An offset to the response. Useful for paging.	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId		Access token identifier used to retrieve an access token from the store

Returns

Return Type	Description
List<Album>	The list of albums

<facebook:get-page-checkins>

Checkins made by the friends of the current session user

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
page		Represents the ID of the page object.	String	/	UTF-8
since	last week	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
until	yesterday	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
limit	100	Optional. Limit the number of items returned.	String	/	UTF-8
offset	0	Optional. An offset to the response. Useful for paging.	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId		Access token identifier used to retrieve an access token from the store

Returns

Return Type	Description
List<Checkin>	response from Facebook

<facebook:get-page-events>

The events this page is attending

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
page		Represents the ID of the page object.	String	/	UTF-8
since	last week	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
until	yesterday	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
limit	100	Optional. Limit the number of items returned.	String	/	UTF-8
offset	0	Optional. An offset to the response. Useful for paging.	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId		Access token identifier used to retrieve an access token from the store

Returns

Return Type	Description
List<Event>	The list of events

<facebook:get-page-groups>

The groups this page is a member of

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
page		Represents the ID of the page object.	String	/	UTF-8
since	last week	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
until	yesterday	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
limit	100	Optional. Limit the number of items returned.	String	/	UTF-8
offset	0	Optional. An offset to the response. Useful for paging.	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId		Access token identifier used to retrieve an access token from the store

Returns

Return Type	Description
List<Group>	The list of groups

<facebook:get-page-links>

The page's posted links

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
page		Represents the ID of the page object.	String	/	UTF-8
since	last week	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
until	yesterday	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
limit	100	Optional. Limit the number of items returned.	String	/	UTF-8
offset	0	Optional. An offset to the response. Useful for paging.	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId		Access token identifier used to retrieve an access token from the store

Returns

Return Type	Description
List<Link>	A list of this page's links

<facebook:get-page-notes>

The page's notes

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
page		Represents the ID of the page object.	String	/	UTF-8
since	last week	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
until	yesterday	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
limit	100	Optional. Limit the number of items returned.	String	/	UTF-8
offset	0	Optional. An offset to the response. Useful for paging.	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId		Access token identifier used to retrieve an access token from the store

Returns

Return Type	Description
List<Note>	response from Facebook

<facebook:get-page-photos>

The photos this page has uploaded

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
page		Represents the ID of the page object.	String	/	UTF-8
since	last week	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
until	yesterday	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
limit	100	Optional. Limit the number of items returned.	String	/	UTF-8
offset	0	Optional. An offset to the response. Useful for paging.	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId		Access token identifier used to retrieve an access token from the store

Returns

Return Type	Description
List<Photo>	A list of photos from this page

<facebook:get-page-picture>

The page's profile picture

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
page		Represents the ID of the page object.	String	/	UTF-8
type	small	Optional. One of square (50x50), small (50 pixels wide, variable height), and large (about 200 pixels wide, variable height)	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId		Access token identifier used to retrieve an access token from the store

Returns

Return Type	Description
byte[]	A byte array with the page picture

<facebook:get-page-posts>

The page's own posts

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
page		Represents the ID of the page object.	String	/	UTF-8
since	last week	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
until	yesterday	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
limit	100	Optional. Limit the number of items returned.	String	/	UTF-8
offset	0	Optional. An offset to the response. Useful for paging.	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId		Access token identifier used to retrieve an access token from the store

Returns

Return Type	Description
List<Post>	A list of posts

<facebook:get-page-statuses>

The page's status updates

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
page		Represents the ID of the page object.	String	/	UTF-8
since	last week	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
until	yesterday	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
limit	100	Optional. Limit the number of items returned.	String	/	UTF-8
offset	0	Optional. An offset to the response. Useful for paging.	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId		Access token identifier used to retrieve an access token from the store

Returns

Return Type	Description
List<StatusMessage>	The list of status messages

<facebook:get-page-tagged>

The photos, videos, and posts in which this page has been tagged

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
page		Represents the ID of the page object.	String	/	UTF-8
since	last week	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
until	yesterday	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
limit	100	Optional. Limit the number of items returned.	String	/	UTF-8
offset	0	Optional. An offset to the response. Useful for paging.	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId		Access token identifier used to retrieve an access token from the store

Returns

Return Type	Description
List<Post>	A list of posts

<facebook:get-page-videos>

The videos this page has created

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
page		Represents the ID of the page object.	String	/	UTF-8
since	last week	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
until	yesterday	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
limit	100	Optional. Limit the number of items returned.	String	/	UTF-8
offset	0	Optional. An offset to the response. Useful for paging.	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId		Access token identifier used to retrieve an access token from the store

Returns

Return Type	Description
List<Video>	The list of videos

<facebook:get-page-wall>

The page's wall

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
page		Represents the ID of the page object.	String	/	UTF-8
since	last week	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
until	yesterday	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
limit	100	Optional. Limit the number of items returned.	String	/	UTF-8
offset	0	Optional. An offset to the response. Useful for paging.	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId		Access token identifier used to retrieve an access token from the store

Returns

Return Type	Description
List<Post>	A list of posts from the given page wall

<facebook:get-photo>

An individual photo

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
photo		Represents the ID of the photo object.	String	/	UTF-8
metadata	0	Optional. The Graph API supports introspection of objects, which enables you to see all of the connections an object has without knowing its type ahead of time.	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId		Access token identifier used to retrieve an access token from the store

Returns

Return Type	Description
Photo	The photo represented by the given id

<facebook:get-photo-comments>

All of the comments on this photo

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
photo		Represents the ID of the photo object.	String	/	UTF-8
since	last week	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
until	yesterday	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
limit	100	Optional. Limit the number of items returned.	String	/	UTF-8
offset	0	Optional. An offset to the response. Useful for paging.	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId		Access token identifier used to retrieve an access token from the store

Returns

Return Type	Description
List<Comment>	The list of comments of the given photo

<facebook:get-photo-likes>

People who like the photo

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
photo		Represents the ID of the photo object.	String	/	UTF-8
since	last week	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
until	yesterday	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
limit	100	Optional. Limit the number of items returned.	String	/	UTF-8
offset	0	Optional. An offset to the response. Useful for paging.	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId		Access token identifier used to retrieve an access token from the store

Returns

Return Type	Description
Post.Likes	The likes from the given photo

<facebook:get-post>

An individual entry in a profile's feed

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
post		Represents the ID of the post object.	String	/	UTF-8
metadata	0	Optional. The Graph API supports introspection of objects, which enables you to see all of the connections an object has without knowing its type ahead of time.	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId		Access token identifier used to retrieve an access token from the store

Returns

Return Type	Description
Post	The post represented by the given id

<facebook:get-post-comments>

All of the comments on this post

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
post		Represents the ID of the post object.	String	/	UTF-8
since	last week	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
until	yesterday	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
limit	100	Optional. Limit the number of items returned.	String	/	UTF-8
offset	0	Optional. An offset to the response. Useful for paging.	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId		Access token identifier used to retrieve an access token from the store

Returns

Return Type	Description
List<Comment>	A list of comments from this post

<facebook:get-status>

A status message on a user's wall

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
status		Represents the ID of the status object.	String	/	UTF-8
metadata	0	Optional. The Graph API supports introspection of objects, which enables you to see all of the connections an object has without knowing its type ahead of time.	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId		Access token identifier used to retrieve an access token from the store

Returns

Return Type	Description
StatusMessage	The status represented by the given id

<facebook:get-status-comments>

All of the comments on this message

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
status		Represents the ID of the status object.	String	/	UTF-8
since	last week	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
until	yesterday	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
limit	100	Optional. Limit the number of items returned.	String	/	UTF-8
offset	0	Optional. An offset to the response. Useful for paging.	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId		Access token identifier used to retrieve an access token from the store

Returns

Return Type	Description
List<Comment>	The list of comments

<facebook:get-user>

A user profile.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
user		Represents the ID of the user object.	String	/	UTF-8
metadata	0	Optional. The Graph API supports introspection of objects, which enables you to see all of the connections an object has without knowing its type ahead of time.	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId		Access token identifier used to retrieve an access token from the store

Returns

Return Type	Description
User	The user represented by the given id

<facebook:get-user-accounts>

The Facebook pages owned by the current user

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
user		Represents the ID of the user object.	String	/	UTF-8
since	last week	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
until	yesterday	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
limit	100	Optional. Limit the number of items returned.	String	/	UTF-8
offset	0	Optional. An offset to the response. Useful for paging.	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId		Access token identifier used to retrieve an access token from the store

Returns

Return Type	Description
List<GetUserAccountResponseType>	A list of objects containing account name, access_token, category, id

<facebook:get-user-activities>

The activities listed on the user's profile

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
user		Represents the ID of the user object.	String	/	UTF-8
since	last week	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
until	yesterday	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
limit	100	Optional. Limit the number of items returned.	String	/	UTF-8
offset	0	Optional. An offset to the response. Useful for paging.	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId		Access token identifier used to retrieve an access token from the store

Returns

Return Type	Description
List<PageConnection>	A list of objects containing activity id, name, category and create_time fields.

<facebook:get-user-albums>

The photo albums this user has created. Requires the user_photos or friend_photos permission

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
user		Represents the ID of the user object.	String	/	UTF-8
since	last week	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
until	yesterday	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
limit	100	Optional. Limit the number of items returned.	String	/	UTF-8
offset	0	Optional. An offset to the response. Useful for paging.	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId		Access token identifier used to retrieve an access token from the store

Returns

Return Type	Description
List<Album>	A list containing the photo albums the given user has created

<facebook:get-user-books>

The books listed on the user's profile

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
user		Represents the ID of the user object.	String	/	UTF-8
since	last week	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
until	yesterday	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
limit	100	Optional. Limit the number of items returned.	String	/	UTF-8
offset	0	Optional. An offset to the response. Useful for paging.	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId		Access token identifier used to retrieve an access token from the store

Returns

Return Type	Description
List<PageConnection>	A list containing the given user's books

<facebook:get-user-checkins>

The music listed on the user's profile

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
user		Represents the ID of the user object.	String	/	UTF-8
since	last week	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
until	yesterday	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
limit	100	Optional. Limit the number of items returned.	String	/	UTF-8
offset	0	Optional. An offset to the response. Useful for paging.	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId		Access token identifier used to retrieve an access token from the store

Returns

Return Type	Description
List<Checkin>	A list with the user checkins

<facebook:get-user-events>

The events this user is attending. Requires the user_events or friend_events permission

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
user		Represents the ID of the user object.	String	/	UTF-8
since	last week	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
until	yesterday	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
limit	100	Optional. Limit the number of items returned.	String	/	UTF-8
offset	0	Optional. An offset to the response. Useful for paging.	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId		Access token identifier used to retrieve an access token from the store

Returns

Return Type	Description
List<Event>	A list containing the events the given user is attending

<facebook:get-user-friends>

The user's friends

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
user		Represents the ID of the user object.	String	/	UTF-8
since	last week	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
until	yesterday	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
limit	100	Optional. Limit the number of items returned.	String	/	UTF-8
offset	0	Optional. An offset to the response. Useful for paging.	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId		Access token identifier used to retrieve an access token from the store

Returns

Return Type	Description
List<NamedFacebookType>	A list of objects with the name and id of the given user's friends

<facebook:get-user-groups>

The groups this user is a member of. Requires the user_groups or friend_groups permission

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
user		Represents the ID of the user object.	String	/	UTF-8
since	last week	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
until	yesterday	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
limit	100	Optional. Limit the number of items returned.	String	/	UTF-8
offset	0	Optional. An offset to the response. Useful for paging.	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId		Access token identifier used to retrieve an access token from the store

Returns

Return Type	Description
List<Group>	A list containing the Groups that the given user belongs to

<facebook:get-user-home>

The user's News Feed. Requires the read_stream permission

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
user		Represents the ID of the user object.	String	/	UTF-8
since	last week	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
until	yesterday	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
limit	100	Optional. Limit the number of items returned.	String	/	UTF-8
offset	0	Optional. An offset to the response. Useful for paging.	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId		Access token identifier used to retrieve an access token from the store

Returns

Return Type	Description
List<Post>	A list of posts

<facebook:get-user-inbox>

The threads in this user's inbox. Requires the read_mailbox permission

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
user		Represents the ID of the user object.	String	/	UTF-8
since	last week	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
until	yesterday	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
limit	100	Optional. Limit the number of items returned.	String	/	UTF-8
offset	0	Optional. An offset to the response. Useful for paging.	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId		Access token identifier used to retrieve an access token from the store

Returns

Return Type	Description
List<Thread>	A list containing the threads in the given user's inbox

<facebook:get-user-interests>

The interests listed on the user's profile

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
user		Represents the ID of the user object.	String	/	UTF-8
since	last week	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
until	yesterday	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
limit	100	Optional. Limit the number of items returned.	String	/	UTF-8
offset	0	Optional. An offset to the response. Useful for paging.	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId		Access token identifier used to retrieve an access token from the store

Returns

Return Type	Description
List<PageConnection>	A list with the user interests

<facebook:get-user-likes>

All the pages this user has liked. Requires the user_likes or friend_likes permission

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
user		Represents the ID of the user object.	String	/	UTF-8
since	last week	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
until	yesterday	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
limit	100	Optional. Limit the number of items returned.	String	/	UTF-8
offset	0	Optional. An offset to the response. Useful for paging.	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId		Access token identifier used to retrieve an access token from the store

Returns

Return Type	Description
List<PageConnection>	A list containing all the pages this user has liked

<facebook:get-user-links>

The user's posted links. Requires the read_stream permission {@sample.xml../../../doc/mule-module-facebook.xml.sample facebook:getUserLinks}

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
user		Represents the ID of the user object.	String	/	UTF-8
since	last week	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
until	yesterday	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
limit	100	Optional. Limit the number of items returned.	String	/	UTF-8
offset	0	Optional. An offset to the response. Useful for paging.	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId		Access token identifier used to retrieve an access token from the store

Returns

Return Type	Description
List<Link>	A list containing the given user's posted links

<facebook:get-user-movies>

The movies listed on the user's profile

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
user		Represents the ID of the user object.	String	/	UTF-8
since	last week	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
until	yesterday	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
limit	100	Optional. Limit the number of items returned.	String	/	UTF-8
offset	0	Optional. An offset to the response. Useful for paging.	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId		Access token identifier used to retrieve an access token from the store

Returns

Return Type	Description
List<PageConnection>	A list containing the given user's movies

<facebook:get-user-music>

The music listed on the user's profile

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
user		Represents the ID of the user object.	String	/	UTF-8
since	last week	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
until	yesterday	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
limit	100	Optional. Limit the number of items returned.	String	/	UTF-8
offset	0	Optional. An offset to the response. Useful for paging.	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId		Access token identifier used to retrieve an access token from the store

Returns

Return Type	Description
List<PageConnection>	A list with the given user's music

<facebook:get-user-notes>

The user's notes. Requires the read_stream permission

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
user		Represents the ID of the user object.	String	/	UTF-8
since	last week	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
until	yesterday	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
limit	100	Optional. Limit the number of items returned.	String	/	UTF-8
offset	0	Optional. An offset to the response. Useful for paging.	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId		Access token identifier used to retrieve an access token from the store

Returns

Return Type	Description
List<Note>	A list containing the given user's notes

<facebook:get-user-outbox>

The messages in this user's outbox. Requires the read_mailbox permission

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
user		Represents the ID of the user object.	String	/	UTF-8
since	last week	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
until	yesterday	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
limit	100	Optional. Limit the number of items returned.	String	/	UTF-8
offset	0	Optional. An offset to the response. Useful for paging.	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId		Access token identifier used to retrieve an access token from the store

Returns

Return Type	Description
List<OutboxThread>	A list of threads

<facebook:get-user-photos>

The photos this user is tagged in. Requires the user_photos or friend_photos permission

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
user		Represents the ID of the user object.	String	/	UTF-8
since	last week	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
until	yesterday	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
limit	100	Optional. Limit the number of items returned.	String	/	UTF-8
offset	0	Optional. An offset to the response. Useful for paging.	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId		Access token identifier used to retrieve an access token from the store

Returns

Return Type	Description
List<Photo>	A list of photos the given user is tagged in

<facebook:get-user-picture>

The user's profile picture

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
user		Represents the ID of the user object.	String	/	UTF-8
type	small	Optional. One of square (50x50), small (50 pixels wide, variable height), and large (about 200 pixels wide, variable height)	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId		Access token identifier used to retrieve an access token from the store

Returns

Return Type	Description
byte[]	byte[] with the jpg image

<facebook:get-user-posts>

The user's own posts. Requires the read_stream permission to see non-public posts.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
user		Represents the ID of the user object.	String	/	UTF-8
since	last week	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
until	yesterday	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
limit	100	Optional. Limit the number of items returned.	String	/	UTF-8
offset	0	Optional. An offset to the response. Useful for paging.	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId		Access token identifier used to retrieve an access token from the store

Returns

Return Type	Description
List<Post>	A list of posts

<facebook:get-user-search>

Search an individual user's News Feed, restricted to that user's friends

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
user		Represents the ID of the user object.	String	/	UTF-8
q	facebook	Optional. The text for which to search.	String	/	UTF-8
metadata	0	Optional. The Graph API supports introspection of objects, which enables you to see all of the connections an object has without knowing its type ahead of time.	String	/	UTF-8
since	last week	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
until	yesterday	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
limit	100	Optional. Limit the number of items returned.	String	/	UTF-8
offset	0	Optional. An offset to the response. Useful for paging.	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId		Access token identifier used to retrieve an access token from the store

Returns

Return Type	Description
List<Post>	A list of posts

<facebook:get-user-statuses>

The user's status updates. Requires the read_stream permission

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
user		Represents the ID of the user object.	String	/	UTF-8
since	last week	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
until	yesterday	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
limit	100	Optional. Limit the number of items returned.	String	/	UTF-8
offset	0	Optional. An offset to the response. Useful for paging.	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId		Access token identifier used to retrieve an access token from the store

Returns

Return Type	Description
List<StatusMessage>	A list contining the user's status updates

<facebook:get-user-tagged>

The photos, videos, and posts in which this user has been tagged. Requires the user_photos, user_video_tags, friends_photos, or friend_video_tags permissions

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
user		Represents the ID of the user object.	String	/	UTF-8
since	last week	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
until	yesterday	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
limit	100	Optional. Limit the number of items returned.	String	/	UTF-8
offset	0	Optional. An offset to the response. Useful for paging.	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId		Access token identifier used to retrieve an access token from the store

Returns

Return Type	Description
List<Post>	response from Facebook

<facebook:get-user-television>

The television listed on the user's profile

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
user		Represents the ID of the user object.	String	/	UTF-8
since	last week	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
until	yesterday	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
limit	100	Optional. Limit the number of items returned.	String	/	UTF-8
offset	0	Optional. An offset to the response. Useful for paging.	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId		Access token identifier used to retrieve an access token from the store

Returns

Return Type	Description
List<PageConnection>	A list containing the television listed on the given user's profile

<facebook:get-user-updates>

The updates in this user's inbox. Requires the read_mailbox permission

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
user		Represents the ID of the user object.	String	/	UTF-8
since	last week	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
until	yesterday	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
limit	100	Optional. Limit the number of items returned.	String	/	UTF-8
offset	0	Optional. An offset to the response. Useful for paging.	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId		Access token identifier used to retrieve an access token from the store

Returns

Return Type	Description
List<OutboxThread>	A list containing the given user updates

<facebook:get-user-videos>

The videos this user has been tagged in. Requires the user_videos or friend_videos permission.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
user		Represents the ID of the user object.	String	/	UTF-8
since	last week	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
until	yesterday	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
limit	100	Optional. Limit the number of items returned.	String	/	UTF-8
offset	0	Optional. An offset to the response. Useful for paging.	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId		Access token identifier used to retrieve an access token from the store

Returns

Return Type	Description
List<Video>	A list containing the videos the given user has been tagged in

<facebook:get-user-wall>

The user's wall. Requires the read_stream permission to see non-public posts.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
user		Represents the ID of the user object.	String	/	UTF-8
since	last week	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
until	yesterday	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
limit	100	Optional. Limit the number of items returned.	String	/	UTF-8
offset	0	Optional. An offset to the response. Useful for paging.	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId		Access token identifier used to retrieve an access token from the store

Returns

Return Type	Description
List<Post>	A list of posts

<facebook:get-video>

An individual video

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
video		Represents the ID of the video object.	String	/	UTF-8
metadata	0	Optional. The Graph API supports introspection of objects, which enables you to see all of the connections an object has without knowing its type ahead of time.	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId		Access token identifier used to retrieve an access token from the store

Returns

Return Type	Description
Video	response from Facebook

<facebook:get-video-comments>

All of the comments on this video

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
video		Represents the ID of the video object.	String	/	UTF-8
since	last week	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
until	yesterday	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
limit	100	Optional. Limit the number of items returned.	String	/	UTF-8
offset	0	Optional. An offset to the response. Useful for paging.	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId		Access token identifier used to retrieve an access token from the store

Returns

Return Type	Description
List<Comment>	A list containing the given video's comments

<facebook:like>

Write to the given profile's feed/wall.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
postId	Represents the ID of the post object.	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId	Access token identifier used to retrieve an access token from the store

<facebook:logged-user-details>

Gets the user logged details.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId		Access token identifier used to retrieve an access token from the store

Returns

Return Type	Description
User	response from Facebook the actual user.

<facebook:publish-album>

Create an album.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
profile_id	The id of the profile object	String	/	UTF-8
msg	The message	String	/	UTF-8
albumName	The name of the album	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId	Access token identifier used to retrieve an access token from the store

<facebook:publish-comment>

Comment on the given post

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
postId	Represents the ID of the post object.	String	/	UTF-8
msg	Comment on the given post	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId	Access token identifier used to retrieve an access token from the store

Returns

Return Type	Description
String	The id of the published comment

<facebook:publish-event>

Post an event in the given profile.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
profile_id	The profile where to publish the event	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId	Access token identifier used to retrieve an access token from the store

<facebook:publish-link>

Write a note on the given profile.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
profile_id	The profile where to publish the link	String	/	UTF-8
msg	The message	String	/	UTF-8
link	The link	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId	Access token identifier used to retrieve an access token from the store

<facebook:publish-message>

Write to the given profile's feed/wall.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
profile_id	The profile where to publish the message	String	/	UTF-8
msg	The message	String	/	UTF-8
picture	Optional. If available, a link to the picture included with this post	String	/	UTF-8
link	Optional. The link attached to this post	String	/	UTF-8
caption	Optional. The caption of the link (appears beneath the link name)	String	/	UTF-8
linkName	Optional. The name of the link	String	/	UTF-8
description	Optional. A description of the link (appears beneath the link caption)	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId	Access token identifier used to retrieve an access token from the store

Returns

Return Type	Description
String	The id of the published object

<facebook:publish-note>

Write a note on the given profile.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
profile_id	The profile where to publish the note	String	/	UTF-8
msg	The message	String	/	UTF-8
subject	The subject of the note	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId	Access token identifier used to retrieve an access token from the store

<facebook:publish-photo>

Upload a photo to an album.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
albumId	The id of the album object	String	/	UTF-8
caption	Caption of the photo	String	/	UTF-8
photo	File containing the photo	File	/
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId	Access token identifier used to retrieve an access token from the store

<facebook:search-checkins>

This request returns you or your friend's latest checkins, or checkins where you or your friends have been tagged; currently, it does not accept a query parameter.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
since	last week	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
until	yesterday	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
limit	100	Optional. Limit the number of items returned.	String	/	UTF-8
offset	0	Optional. An offset to the response. Useful for paging.	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId		Access token identifier used to retrieve an access token from the store

Returns

Return Type	Description
List<Checkin>	A list of checkins

<facebook:search-events>

Search over all events in the social graph

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
q		The search string	String	/	UTF-8
since	last week	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
until	yesterday	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
limit	100	Optional. Limit the number of items returned.	String	/	UTF-8
offset	0	Optional. An offset to the response. Useful for paging.	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId		Access token identifier used to retrieve an access token from the store

Returns

Return Type	Description
List<Event>	A list of events

<facebook:search-groups>

Search over all groups in the social graph

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
q		The search string	String	/	UTF-8
since	last week	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
until	yesterday	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
limit	100	Optional. Limit the number of items returned.	String	/	UTF-8
offset	0	Optional. An offset to the response. Useful for paging.	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId		Access token identifier used to retrieve an access token from the store

Returns

Return Type	Description
List<Group>	A list of groups

<facebook:search-pages>

Search over all pages in the social graph

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
q		The search string	String	/	UTF-8
since	last week	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
until	yesterday	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
limit	100	Optional. Limit the number of items returned.	String	/	UTF-8
offset	0	Optional. An offset to the response. Useful for paging.	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId		Access token identifier used to retrieve an access token from the store

Returns

Return Type	Description
List<Page>	A list of pages

<facebook:search-posts>

Search over all public posts in the social graph

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
q		The search string	String	/	UTF-8
since	last week	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
until	yesterday	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
limit	100	Optional. Limit the number of items returned.	String	/	UTF-8
offset	0	Optional. An offset to the response. Useful for paging.	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId		Access token identifier used to retrieve an access token from the store

Returns

Return Type	Description
List<Post>	A list of posts

<facebook:search-users>

Search over all users in the social graph

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
q		The search string	String	/	UTF-8
since	last week	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
until	yesterday	Optional. A unix timestamp or any date accepted by strtotime	String	/	UTF-8
limit	100	Optional. Limit the number of items returned.	String	/	UTF-8
offset	0	Optional. An offset to the response. Useful for paging.	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId		Access token identifier used to retrieve an access token from the store

Returns

Return Type	Description
List<User>	A list of users

<facebook:tentative-event>

Maybe attend the given event.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
eventId	Represents the id of the event object	String	/	UTF-8
OAuth Parameters The following values are always required when using OAuth as the authentication mechanism.
accessTokenId	Access token identifier used to retrieve an access token from the store