com.google.code.facebookapi
Class FacebookXmlRestClient

java.lang.Object
  com.google.code.facebookapi.BaseAdapter
      com.google.code.facebookapi.SpecificReturnTypeAdapter<org.w3c.dom.Document>
          com.google.code.facebookapi.FacebookXmlRestClientBase
              com.google.code.facebookapi.FacebookXmlRestClient

All Implemented Interfaces:

IFacebookRestClient<org.w3c.dom.Document>

public class FacebookXmlRestClient
extends FacebookXmlRestClientBase

Field Summary

Fields inherited from class com.google.code.facebookapi.FacebookXmlRestClientBase

factory, log

Fields inherited from class com.google.code.facebookapi.BaseAdapter

client, responseFormat

Fields inherited from interface com.google.code.facebookapi.IFacebookRestClient

ERROR_TAG, TARGET_API_VERSION

Constructor Summary

FacebookXmlRestClient(ExtensibleClient client)

FacebookXmlRestClient(java.lang.String apiKey, java.lang.String secret)

FacebookXmlRestClient(java.lang.String apiKey, java.lang.String secret, java.lang.String sessionKey)

FacebookXmlRestClient(java.lang.String apiKey, java.lang.String secret, java.lang.String sessionKey, boolean sessionSecret)

Method Summary

org.w3c.dom.Document	admin_getDailyMetrics(java.util.Set<Metric> metrics, java.util.Date start, java.util.Date end) Deprecated.
org.w3c.dom.Document	admin_getDailyMetrics(java.util.Set<Metric> metrics, long start, long end) Deprecated.
org.w3c.dom.Document	admin_getMetrics(java.util.Set<Metric> metrics, java.util.Date start, java.util.Date end, long period) Retrieve metrics for the current application.
org.w3c.dom.Document	admin_getMetrics(java.util.Set<Metric> metrics, long start, long end, long period) Retrieve the daily metrics for the current application.
org.w3c.dom.Document	application_getPublicInfo(java.lang.Long applicationId, java.lang.String applicationKey, java.lang.String applicationCanvas) Gets the public information about the specified application.
org.w3c.dom.Document	application_getPublicInfoByApiKey(java.lang.String applicationKey) Gets the public information about the specified application, by API key.
org.w3c.dom.Document	application_getPublicInfoByCanvasName(java.lang.String applicationCanvas) Gets the public information about the specified application, by canvas-page name.
org.w3c.dom.Document	application_getPublicInfoById(java.lang.Long applicationId) Gets the public information about the specified application, by application id.
org.w3c.dom.Document	batch_run(java.lang.String methods, boolean serial) Executes a batch of queries.
org.w3c.dom.Document	connect_registerUsers(java.util.Collection<java.util.Map<java.lang.String,java.lang.String>> accounts) This method is used to create an association between an external user account and a Facebook user account.
org.w3c.dom.Document	connect_unregisterUsers(java.util.Collection<java.lang.String> email_hashes) This method allows a site to unregister a previously registered account (using connect.registerUsers).
org.w3c.dom.Document	dashboard_multiAddNews(java.util.Collection<java.lang.Long> userIds, java.util.Collection<DashboardNewsItem> newsItems) Non-imageUrl method signature form.
org.w3c.dom.Document	dashboard_multiAddNews(java.util.Collection<java.lang.Long> userIds, java.util.Collection<DashboardNewsItem> newsItems, java.lang.String imageUrl) Adds all of the supplied news items to each of the users specified.
org.w3c.dom.Document	dashboard_multiClearNews(java.util.Collection<java.lang.Long> userIds) Clears all of the news items associated to the specified users.
org.w3c.dom.Document	dashboard_multiClearNews(java.util.Map<java.lang.Long,java.util.Collection<java.lang.Long>> userIdToNewsIdsMap) Removes the referenced news items against each of the users specified.
org.w3c.dom.Document	data_getAssociationDefinition(java.lang.String associationName)
org.w3c.dom.Document	data_getAssociationDefinitions()
org.w3c.dom.Document	data_getCookies() Get all cookies for the currently logged-in user.
org.w3c.dom.Document	data_getCookies(java.lang.Long userId) Get all cookies for the specified user.
org.w3c.dom.Document	data_getCookies(java.lang.Long userId, java.lang.CharSequence name) Get a specific cookie for the specified user.
org.w3c.dom.Document	data_getCookies(java.lang.String name) Get a specific cookie for the currently logged-in user.
org.w3c.dom.Document	data_getObject(long objectId)
org.w3c.dom.Document	data_getObjectProperty(long objectId, java.lang.String propertyName)
org.w3c.dom.Document	data_getObjects(java.util.Collection<java.lang.Long> objectIds)
org.w3c.dom.Document	data_getObjectType(java.lang.String objectType)
org.w3c.dom.Document	data_getObjectTypes()
org.w3c.dom.Document	data_getUserPreferences() Get a map containing all preference values set for the current user.
org.w3c.dom.Document	events_get(java.lang.Long userId, java.util.Collection<java.lang.Long> eventIds, java.lang.Long startTime, java.lang.Long endTime) Returns all visible events according to the filters specified.
org.w3c.dom.Document	events_get(java.lang.Long userId, java.util.Collection<java.lang.Long> eventIds, java.lang.Long startTime, java.lang.Long endTime, java.lang.String rsvp_status) Returns all visible events according to the filters specified.
org.w3c.dom.Document	events_getMembers(java.lang.Long eventId) Retrieves the membership list of an event
org.w3c.dom.Document	fbml_getCustomTags(java.lang.String appId) Returns the custom tag definitions for tags that were previously defined using fbml.registerCustomTags.
org.w3c.dom.Document	feed_getRegisteredTemplateBundleByID(java.lang.Long id) Deprecated.
org.w3c.dom.Document	feed_getRegisteredTemplateBundles() Deprecated.
org.w3c.dom.Document	fql_query(java.lang.CharSequence query) Retrieves the results of a Facebook Query Language query
org.w3c.dom.Document	friends_areFriends(java.util.Collection<java.lang.Long> userIds1, java.util.Collection<java.lang.Long> userIds2) Retrieves whether pairs of users are friends.
org.w3c.dom.Document	friends_areFriends(long userId1, long userId2) Retrieves whether two users are friends.
org.w3c.dom.Document	friends_get() Retrieves the friends of the currently logged in user.
org.w3c.dom.Document	friends_get(java.lang.Long uid) Retrieves the friends uid.
org.w3c.dom.Document	friends_getAppUsers() Retrieves the friends of the currently logged in user, who are also users of the calling application.
org.w3c.dom.Document	friends_getList(java.lang.Long friendListId) Retrieves the friends of the currently logged in user that are members of the friends list with ID friendListId.
org.w3c.dom.Document	friends_getLists() Retrieves the friend lists of the currently logged in user.
org.w3c.dom.Document	friends_getMutualFriends(java.lang.Long targetId) Returns the Facebook user IDs of the mutual friends between the source user and target user.
org.w3c.dom.Document	friends_getMutualFriends(java.lang.Long sourceId, java.lang.Long targetId) Returns the Facebook user IDs of the mutual friends between the source user and target user.
org.w3c.dom.Document	groups_get(java.lang.Long userId, java.util.Collection<java.lang.Long> groupIds) Retrieves the groups associated with a user
org.w3c.dom.Document	groups_getMembers(java.lang.Number groupId) Retrieves the membership list of a group
org.w3c.dom.Document	notifications_get() Deprecated.
org.w3c.dom.Document	pages_getInfo(java.util.Collection<java.lang.Long> pageIds, java.util.Collection<PageProfileField> fields) Retrieves the requested profile fields for the Facebook Pages with the given pageIds.
org.w3c.dom.Document	pages_getInfo(java.util.Collection<java.lang.Long> pageIds, java.util.Set<java.lang.CharSequence> fields) Retrieves the requested profile fields for the Facebook Pages with the given pageIds.
org.w3c.dom.Document	pages_getInfo(java.lang.Long userId, java.util.Collection<PageProfileField> fields) Retrieves the requested profile fields for the Facebook Pages of the user with the given userId.
org.w3c.dom.Document	pages_getInfo(java.lang.Long userId, java.util.Set<java.lang.CharSequence> fields) Retrieves the requested profile fields for the Facebook Pages of the user with the given userId.
org.w3c.dom.Document	payments_getOrders(java.lang.String status, long startTime, long endTime) Returns all orders for the given application
org.w3c.dom.Document	permissions_checkAvailableApiAccess(java.lang.String apiKey) Check to see what permissions have been granted to current app by the specified external application.
org.w3c.dom.Document	permissions_checkGrantedApiAccess(java.lang.String apiKey) Check to see what permissions have been granted to specified external application by the current application.
org.w3c.dom.Document	photos_addTags(java.lang.String photoId, java.util.Collection<PhotoTag> tags) Adds several tags to a photo.
org.w3c.dom.Document	photos_addTags(java.lang.String photoId, java.util.Collection<PhotoTag> tags, java.lang.Long userId) Adds several tags to a photo.
org.w3c.dom.Document	photos_createAlbum(java.lang.String albumName) Creates an album.
org.w3c.dom.Document	photos_createAlbum(java.lang.String albumName, java.lang.Long userId) Creates an album.
org.w3c.dom.Document	photos_createAlbum(java.lang.String name, java.lang.String description, java.lang.String location) Creates an album.
org.w3c.dom.Document	photos_createAlbum(java.lang.String name, java.lang.String description, java.lang.String location, java.lang.Long userId) Creates an album.
org.w3c.dom.Document	photos_get(java.util.Collection<java.lang.String> photoIds) Used to retrieve photo objects using the search parameters (one or more of the parameters must be provided).
org.w3c.dom.Document	photos_get(java.lang.Long subjId) Used to retrieve photo objects using the search parameters (one or more of the parameters must be provided).
org.w3c.dom.Document	photos_get(java.lang.Long subjId, java.util.Collection<java.lang.String> photoIds) Used to retrieve photo objects using the search parameters (one or more of the parameters must be provided).
org.w3c.dom.Document	photos_get(java.lang.Long subjId, java.lang.String albumId) Used to retrieve photo objects using the search parameters (one or more of the parameters must be provided).
org.w3c.dom.Document	photos_get(java.lang.Long subjId, java.lang.String albumId, java.util.Collection<java.lang.String> photoIds) Used to retrieve photo objects using the search parameters (one or more of the parameters must be provided).
org.w3c.dom.Document	photos_getAlbums(java.util.Collection<java.lang.String> albumIds) Retrieves album metadata for a list of album IDs.
org.w3c.dom.Document	photos_getAlbums(java.lang.Long userId) Retrieves album metadata for albums owned by a user.
org.w3c.dom.Document	photos_getAlbums(java.lang.Long userId, java.util.Collection<java.lang.String> albumIds) Retrieves album metadata.
org.w3c.dom.Document	photos_getByAlbum(java.lang.String albumId) Used to retrieve photo objects using the search parameters (one or more of the parameters must be provided).
org.w3c.dom.Document	photos_getByAlbum(java.lang.String albumId, java.util.Collection<java.lang.String> photoIds) Used to retrieve photo objects using the search parameters (one or more of the parameters must be provided).
org.w3c.dom.Document	photos_getTags(java.util.Collection<java.lang.String> photoIds) Retrieves the tags for the given set of photos.
org.w3c.dom.Document	photos_upload(java.io.File photo) Uploads a photo to Facebook.
org.w3c.dom.Document	photos_upload(java.io.File photo, java.lang.String caption, java.lang.String albumId) Uploads a photo to Facebook.
org.w3c.dom.Document	photos_upload(java.lang.Long userId, java.io.File photo) Uploads a photo to Facebook.
org.w3c.dom.Document	photos_upload(java.lang.Long userId, java.io.File photo, java.lang.String caption, java.lang.String albumId) Uploads a photo to Facebook.
org.w3c.dom.Document	photos_upload(java.lang.Long userId, java.lang.String caption, java.lang.String albumId, java.lang.String fileName, java.io.InputStream fileStream) Uploads a photo to Facebook.
org.w3c.dom.Document	photos_uploadToAlbum(java.io.File photo, java.lang.String albumId) Uploads a photo to Facebook.
org.w3c.dom.Document	photos_uploadToAlbum(java.lang.Long userId, java.io.File photo, java.lang.String albumId) Uploads a photo to Facebook.
org.w3c.dom.Document	photos_uploadWithCaption(java.io.File photo, java.lang.String caption) Uploads a photo to Facebook.
org.w3c.dom.Document	photos_uploadWithCaption(java.lang.Long userId, java.io.File photo, java.lang.String caption) Uploads a photo to Facebook.
org.w3c.dom.Document	profile_getFBML() Deprecated.
org.w3c.dom.Document	profile_getFBML(int type) Deprecated.
org.w3c.dom.Document	profile_getFBML(int type, java.lang.Long userId) Deprecated.
org.w3c.dom.Document	profile_getFBML(java.lang.Long userId) Deprecated.
org.w3c.dom.Document	profile_getInfo(java.lang.Long userId) Deprecated.
org.w3c.dom.Document	profile_getInfoOptions(java.lang.String field) Deprecated.
org.w3c.dom.Document	stream_get(java.lang.Long viewerId, java.util.List<java.lang.Long> sourceIds, java.util.Date start, java.util.Date end, java.lang.Integer limit, java.lang.String filterKey, java.util.List<java.lang.String> metadata)
org.w3c.dom.Document	stream_getComments(java.lang.String postId)
org.w3c.dom.Document	stream_getFilters(java.lang.Long userId)
org.w3c.dom.Document	users_getInfo(java.lang.Iterable<java.lang.Long> userIds, java.util.Collection<ProfileField> fields) Retrieves the requested info fields for the requested set of users.
org.w3c.dom.Document	users_getInfo(java.lang.Iterable<java.lang.Long> userIds, java.util.Set<java.lang.CharSequence> fields) Retrieves the requested info fields for the requested set of users.
org.w3c.dom.Document	users_getStandardInfo(java.util.Collection<java.lang.Long> userIds, java.util.Collection<ProfileField> fields) Returns an array of user-specific information for each user identifier passed, limited by the view of the current user.
org.w3c.dom.Document	users_getStandardInfo(java.util.Collection<java.lang.Long> userIds, java.util.Set<java.lang.CharSequence> fields) Returns an array of user-specific information for each user identifier passed, limited by the view of the current user.

Methods inherited from class com.google.code.facebookapi.FacebookXmlRestClientBase

executeBatch, isNamespaceAware, parseCallResult, printDom, setNamespaceAware

Methods inherited from class com.google.code.facebookapi.SpecificReturnTypeAdapter

admin_getAllocation, admin_getAllocation, admin_getAllocation, admin_getAllocation, admin_getAppProperties, admin_getAppPropertiesAsSet, admin_getAppPropertiesAsString, admin_getAppPropertiesMap, admin_getNotificationAllocation, admin_getRequestAllocation, admin_setAppProperties, admin_setAppProperties, auth_createToken, auth_expireSession, auth_getSession, auth_getSession, auth_promoteSession, auth_revokeAuthorization, auth_revokeExtendedPermission, auth_revokeExtendedPermission, connect_getUnconnectedFriendsCount, dashboard_addGlobalNews, dashboard_addGlobalNews, dashboard_clearGlobalNews, dashboard_clearGlobalNews, dashboard_multiIncrementCount, dashboard_publishActivity, dashboard_publishActivity, data_createObject, data_getAssociatedObjectCount, data_getUserPreference, data_setCookie, data_setCookie, data_setCookie, data_setCookie, data_setCookie, data_setCookie, data_setCookie, data_setCookie, events_cancel, events_create, events_edit, events_rsvp, fbml_refreshImgSrc, fbml_refreshImgSrc, fbml_refreshRefUrl, fbml_refreshRefUrl, fbml_setRefHandle, feed_deactivateTemplateBundleByID, feed_publishTemplatizedAction, feed_publishTemplatizedAction, feed_publishTemplatizedAction, feed_publishTemplatizedAction, feed_publishTemplatizedAction, feed_publishTemplatizedAction, feed_publishTemplatizedAction, feed_PublishTemplatizedAction, feed_publishUserAction, feed_publishUserAction, feed_publishUserAction, feed_registerTemplateBundle, feed_registerTemplateBundle, feed_registerTemplateBundle, feed_registerTemplateBundle, feed_registerTemplateBundle, getCacheAppUser, getCacheSessionExpires, getCacheSessionKey, getCacheUserId, intl_uploadNativeStrings, isDesktop, links_post, liveMessage_send, notifications_send, notifications_send, notifications_send, notifications_send, notifications_sendEmail, notifications_sendEmail, notifications_sendEmailPlain, notifications_sendEmailStr, notifications_sendEmailToCurrentUser, notifications_sendFbmlEmail, notifications_sendFbmlEmailToCurrentUser, notifications_sendTextEmail, notifications_sendTextEmailToCurrentUser, pages_isAdmin, pages_isAppAdded, pages_isFan, pages_isFan, permissions_grantApiAccess, permissions_grantFullApiAccess, permissions_revokeApiAccess, photos_addTag, photos_addTag, photos_addTag, photos_addTag, profile_setFBML, profile_setFBML, profile_setFBML, profile_setFBML, profile_setFBML, profile_setFBML, profile_setMobileFBML, profile_setMobileFBML, profile_setProfileActionFBML, profile_setProfileActionFBML, profile_setProfileFBML, profile_setProfileFBML, sms_canSend, sms_canSend, sms_send, sms_send, sms_sendMessageWithSession, stream_addComment, stream_addLike, stream_publish, stream_remove, stream_removeComment, stream_removeLike, users_clearStatus, users_getLoggedInUser, users_hasAppPermission, users_hasAppPermission, users_isAppUser, users_isAppUser, users_setStatus, users_setStatus, users_setStatus, users_setStatus, users_setStatus, users_setStatus

Methods inherited from class com.google.code.facebookapi.BaseAdapter

beginBatch, beginPermissionsMode, data_createObjectType, data_defineAssociation, data_defineObjectProperty, data_deleteObject, data_deleteObjects, data_dropObjectType, data_removeAssociatedObjects, data_removeAssociation, data_renameAssociation, data_renameObjectProperty, data_renameObjectType, data_setAssociation, data_setObjectProperty, data_setUserPreference, data_setUserPreferences, data_undefineAssociation, data_undefineObjectProperty, data_updateObject, endPermissionsMode, fbml_deleteCustomTags, fbml_registerCustomTags, getApiKey, getClient, getConnectTimeout, getRawResponse, getReadTimeout, getResponseFormat, getSecret, getServerUrl, profile_setInfo, profile_setInfoOptions, setCacheAppUser, setCacheSession, setCommunicationStrategy, setConnectTimeout, setReadTimeout, setServerUrl, setServerUrl, sms_sendMessage

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.google.code.facebookapi.IFacebookRestClient

beginBatch, beginPermissionsMode, data_createObjectType, data_defineAssociation, data_defineObjectProperty, data_deleteObject, data_deleteObjects, data_dropObjectType, data_removeAssociatedObjects, data_removeAssociation, data_renameAssociation, data_renameObjectProperty, data_renameObjectType, data_setAssociation, data_setObjectProperty, data_setUserPreference, data_setUserPreferences, data_undefineAssociation, data_undefineObjectProperty, data_updateObject, endPermissionsMode, fbml_deleteCustomTags, fbml_registerCustomTags, getApiKey, getConnectTimeout, getRawResponse, getReadTimeout, getResponseFormat, getSecret, getServerUrl, profile_setInfo, profile_setInfoOptions, setCacheAppUser, setCacheSession, setConnectTimeout, setReadTimeout, setServerUrl, setServerUrl, sms_sendMessage

Constructor Detail

FacebookXmlRestClient

public FacebookXmlRestClient(ExtensibleClient client)

FacebookXmlRestClient

public FacebookXmlRestClient(java.lang.String apiKey,
                             java.lang.String secret)

FacebookXmlRestClient

public FacebookXmlRestClient(java.lang.String apiKey,
                             java.lang.String secret,
                             java.lang.String sessionKey)

FacebookXmlRestClient

public FacebookXmlRestClient(java.lang.String apiKey,
                             java.lang.String secret,
                             java.lang.String sessionKey,
                             boolean sessionSecret)

Method Detail

profile_getFBML

@Deprecated
public org.w3c.dom.Document profile_getFBML()
                                     throws FacebookException

Deprecated.

Description copied from interface: IFacebookRestClient

Gets the FBML for the current user's profile box.

Returns:

a T containing FBML markup

Throws:

FacebookException

See Also:

IFacebookRestClient.profile_getFBML(int, Long)

admin_getDailyMetrics

@Deprecated
public org.w3c.dom.Document admin_getDailyMetrics(java.util.Set<Metric> metrics,
                                                             java.util.Date start,
                                                             java.util.Date end)
                                           throws FacebookException

Deprecated.

Description copied from interface: IFacebookRestClient

Retrieve the daily metrics for the current application.

Parameters:

metrics - a set specifying the specific metrics to retrieve

start - the starting date to retrieve data for (range must not exceed 30 days)

end - the ending to to retrive data for (range must not exceed 30 days)

Returns:

daily metrics for your app, for each day in the specified range

Throws:

FacebookException

See Also:

http://wiki.developers.facebook.com/index.php/Admin.getDailyMetrics

data_getCookies

public org.w3c.dom.Document data_getCookies()
                                     throws FacebookException

Description copied from interface: IFacebookRestClient

Get all cookies for the currently logged-in user.

Returns:

all cookies for the current user.

Throws:

FacebookException

feed_getRegisteredTemplateBundleByID

@Deprecated
public org.w3c.dom.Document feed_getRegisteredTemplateBundleByID(java.lang.Long id)
                                                          throws FacebookException

Deprecated.

Description copied from interface: IFacebookRestClient

Retrieve a template bundle by id.

Parameters:

id - the id to retrieve.

Returns:

the specified template bundle definition.

Throws:

FacebookException

friends_get

public org.w3c.dom.Document friends_get()
                                 throws FacebookException

Description copied from interface: IFacebookRestClient

Retrieves the friends of the currently logged in user.

Throws:

FacebookException

See Also:

http://wiki.developers.facebook.com/index.php/Friends.get

friends_get

public org.w3c.dom.Document friends_get(java.lang.Long uid)
                                 throws FacebookException

Description copied from interface: IFacebookRestClient

Retrieves the friends uid.

Throws:

FacebookException

See Also:

http://wiki.developers.facebook.com/index.php/Friends.get

photos_createAlbum

public org.w3c.dom.Document photos_createAlbum(java.lang.String name,
                                               java.lang.String description,
                                               java.lang.String location,
                                               java.lang.Long userId)
                                        throws FacebookException

Description copied from interface: IFacebookRestClient

Creates an album.

Parameters:

name - The album name.

description - The album description (optional).

location - The album location (optional).

userId - the id of the user creating the album.

Returns:

an array of photo objects.

Throws:

FacebookException

admin_getMetrics

public org.w3c.dom.Document admin_getMetrics(java.util.Set<Metric> metrics,
                                             java.util.Date start,
                                             java.util.Date end,
                                             long period)
                                      throws FacebookException

Description copied from interface: IFacebookRestClient

Retrieve metrics for the current application.

Parameters:

metrics - a set specifying the specific metrics to retrieve

start - the starting date to retrieve data for (range must not exceed 30 days)

end - the ending to to retrive data for (range must not exceed 30 days)

period - a number specifying the desired period to group the metrics by, in seconds, Facebook currently only supports Metric.PERIOD_DAY, Metric.PERIOD_WEEK, and Metric.PERIOD_MONTH

Returns:

daily metrics for your app, for each day in the specified range

Throws:

FacebookException

See Also:

http://wiki.developers.facebook.com/index.php/Admin.getMetrics

data_getCookies

public org.w3c.dom.Document data_getCookies(java.lang.Long userId,
                                            java.lang.CharSequence name)
                                     throws FacebookException

Description copied from interface: IFacebookRestClient

Get a specific cookie for the specified user.

Parameters:

userId - the id of the user to get the cookies for.

name - the name of the cookie to retrieve.

Returns:

the specified cookie for the specified user.

Throws:

FacebookException

photos_addTags

public org.w3c.dom.Document photos_addTags(java.lang.String photoId,
                                           java.util.Collection<PhotoTag> tags)
                                    throws FacebookException

Description copied from interface: IFacebookRestClient

Adds several tags to a photo.

Parameters:

photoId - The photo id of the photo to be tagged.

tags - A list of PhotoTags.

Returns:

a list of booleans indicating whether the tag was successfully added.

Throws:

FacebookException

photos_addTags

public org.w3c.dom.Document photos_addTags(java.lang.String photoId,
                                           java.util.Collection<PhotoTag> tags,
                                           java.lang.Long userId)
                                    throws FacebookException

Description copied from interface: IFacebookRestClient

Adds several tags to a photo.

Parameters:

photoId - The photo id of the photo to be tagged.

tags - A list of PhotoTags.

userId - the id of the user adding the tags.

Returns:

a list of booleans indicating whether the tag was successfully added.

Throws:

FacebookException

data_getObjectProperty

public org.w3c.dom.Document data_getObjectProperty(long objectId,
                                                   java.lang.String propertyName)
                                            throws FacebookException

Throws:

FacebookException

permissions_checkAvailableApiAccess

public org.w3c.dom.Document permissions_checkAvailableApiAccess(java.lang.String apiKey)
                                                         throws FacebookException

Description copied from interface: IFacebookRestClient

Check to see what permissions have been granted to current app by the specified external application. For example: Application A grants permission on users.getInfo to Application B, Applicatio B can then call permissions_checkAvailableApiAccess(A) and will recieve "users.getInfo" as a result.

Parameters:

apiKey - the API key of the application to check for permissions from.

Returns:

a list of all API methods that the specified application has permission to use.

Throws:

FacebookException

dashboard_multiAddNews

public org.w3c.dom.Document dashboard_multiAddNews(java.util.Collection<java.lang.Long> userIds,
                                                   java.util.Collection<DashboardNewsItem> newsItems,
                                                   java.lang.String imageUrl)
                                            throws FacebookException

Description copied from interface: IFacebookRestClient

Adds all of the supplied news items to each of the users specified.

Parameters:

userIds - Target users. Each user will be the target of all of the supplied news items.

imageUrl - Absolute URL of image used to replace application logo in the dashboard. (optional)

Returns:

Set of user ids for which the operation was successful.

Throws:

FacebookException

friends_getAppUsers

public org.w3c.dom.Document friends_getAppUsers()
                                         throws FacebookException

Description copied from interface: IFacebookRestClient

Retrieves the friends of the currently logged in user, who are also users of the calling application.

Returns:

array of friends

Throws:

FacebookException

data_getObjectTypes

public org.w3c.dom.Document data_getObjectTypes()
                                         throws FacebookException

Throws:

FacebookException

data_getObject

public org.w3c.dom.Document data_getObject(long objectId)
                                    throws FacebookException

Throws:

FacebookException

photos_uploadWithCaption

public org.w3c.dom.Document photos_uploadWithCaption(java.lang.Long userId,
                                                     java.io.File photo,
                                                     java.lang.String caption)
                                              throws FacebookException

Description copied from interface: IFacebookRestClient

Uploads a photo to Facebook.

Parameters:

userId - the id of the user uploading the photo

photo - an image file

caption - a description of the image contents

Returns:

a T with the standard Facebook photo information

Throws:

FacebookException

See Also:

Developers wiki: Photos.upload

fbml_getCustomTags

public org.w3c.dom.Document fbml_getCustomTags(java.lang.String appId)
                                        throws FacebookException

Description copied from interface: IFacebookRestClient

Returns the custom tag definitions for tags that were previously defined using fbml.registerCustomTags.

Parameters:

appId - The ID of the application whose custom tags you want to get. If the ID is the calling application's ID, all the application's custom tags are returned. Otherwise, only the application's public custom tags are returned. (Default value is the calling application's ID.).

Throws:

FacebookException

See Also:

http://wiki.developers.facebook.com/index.php/Fbml.getCustomTags

users_getInfo

public org.w3c.dom.Document users_getInfo(java.lang.Iterable<java.lang.Long> userIds,
                                          java.util.Collection<ProfileField> fields)
                                   throws FacebookException

Description copied from interface: IFacebookRestClient

Retrieves the requested info fields for the requested set of users.

Parameters:

userIds - a collection of user IDs for which to fetch info

fields - a set of ProfileFields

Returns:

a T consisting of a list of users, with each user element containing the requested fields.

Throws:

FacebookException

See Also:

http://wiki.developers.facebook.com/index.php/Users.getInfo

stream_get

public org.w3c.dom.Document stream_get(java.lang.Long viewerId,
                                       java.util.List<java.lang.Long> sourceIds,
                                       java.util.Date start,
                                       java.util.Date end,
                                       java.lang.Integer limit,
                                       java.lang.String filterKey,
                                       java.util.List<java.lang.String> metadata)
                                throws FacebookException

Throws:

FacebookException

dashboard_multiAddNews

public org.w3c.dom.Document dashboard_multiAddNews(java.util.Collection<java.lang.Long> userIds,
                                                   java.util.Collection<DashboardNewsItem> newsItems)
                                            throws FacebookException

Description copied from interface: IFacebookRestClient

Non-imageUrl method signature form.

Throws:

FacebookException

See Also:

IFacebookRestClient.dashboard_multiAddNews(Collection, Collection, String)

data_getUserPreferences

public org.w3c.dom.Document data_getUserPreferences()
                                             throws FacebookException

Description copied from interface: IFacebookRestClient

Get a map containing all preference values set for the current user.

Returns:

a map of preference values, keyed by preference id. The map will contain all preferences that have been set for the current user. If there are no preferences currently set, the map will be empty. The map returned will never be null.

Throws:

FacebookException - if an error happens when executing the API call.

data_getObjectType

public org.w3c.dom.Document data_getObjectType(java.lang.String objectType)
                                        throws FacebookException

Throws:

FacebookException

photos_get

public org.w3c.dom.Document photos_get(java.util.Collection<java.lang.String> photoIds)
                                throws FacebookException

Description copied from interface: IFacebookRestClient

Used to retrieve photo objects using the search parameters (one or more of the parameters must be provided).

Parameters:

photoIds - retrieve from this list of photos (optional)

Returns:

an T of photo objects.

Throws:

FacebookException

See Also:

#photos_get(Long, Long, Collection), Developers Wiki: Photos.get

permissions_checkGrantedApiAccess

public org.w3c.dom.Document permissions_checkGrantedApiAccess(java.lang.String apiKey)
                                                       throws FacebookException

Description copied from interface: IFacebookRestClient

Check to see what permissions have been granted to specified external application by the current application. For example: Application A grants permission on users.getInfo to Application B, Applicatio A can then call permissions_checkGrantedApiAccess(B) and will recieve "users.getInfo" as a result.

Parameters:

apiKey - the API key of the application to check permissions for.

Returns:

a list of all API methods that the specified application has permission to use.

Throws:

FacebookException

photos_upload

public org.w3c.dom.Document photos_upload(java.io.File photo,
                                          java.lang.String caption,
                                          java.lang.String albumId)
                                   throws FacebookException

Description copied from interface: IFacebookRestClient

Uploads a photo to Facebook.

Parameters:

photo - an image file

caption - a description of the image contents

albumId - the album into which the photo should be uploaded

Returns:

a T with the standard Facebook photo information

Throws:

FacebookException

See Also:

Developers wiki: Photos.upload

photos_upload

public org.w3c.dom.Document photos_upload(java.io.File photo)
                                   throws FacebookException

Description copied from interface: IFacebookRestClient

Uploads a photo to Facebook.

Parameters:

photo - an image file

Returns:

a T with the standard Facebook photo information

Throws:

FacebookException

See Also:

Developers wiki: Photos.upload

photos_upload

public org.w3c.dom.Document photos_upload(java.lang.Long userId,
                                          java.io.File photo,
                                          java.lang.String caption,
                                          java.lang.String albumId)
                                   throws FacebookException

Description copied from interface: IFacebookRestClient

Uploads a photo to Facebook.

Parameters:

userId - the id of the user uploading the photo

photo - an image file

caption - a description of the image contents

albumId - the album into which the photo should be uploaded

Returns:

a T with the standard Facebook photo information

Throws:

FacebookException

See Also:

Developers wiki: Photos.upload

pages_getInfo

public org.w3c.dom.Document pages_getInfo(java.util.Collection<java.lang.Long> pageIds,
                                          java.util.Set<java.lang.CharSequence> fields)
                                   throws FacebookException

Description copied from interface: IFacebookRestClient

Retrieves the requested profile fields for the Facebook Pages with the given pageIds. Can be called for pages that have added the application without establishing a session.

Parameters:

pageIds - the page IDs

fields - a set of page profile fields

Returns:

a T consisting of a list of pages, with each page element containing the requested fields.

Throws:

FacebookException

See Also:

Developers Wiki: Pages.getInfo

stream_getComments

public org.w3c.dom.Document stream_getComments(java.lang.String postId)
                                        throws FacebookException

Throws:

FacebookException

users_getStandardInfo

public org.w3c.dom.Document users_getStandardInfo(java.util.Collection<java.lang.Long> userIds,
                                                  java.util.Collection<ProfileField> fields)
                                           throws FacebookException

Description copied from interface: IFacebookRestClient

Returns an array of user-specific information for each user identifier passed, limited by the view of the current user. The information you can get from this call is limited to: uid, first_name, last_name, name, timezone, birthday, sex, affiliations (regional type only)

Parameters:

userIds - a collection of user IDs for which to fetch info

fields - a set of ProfileFields

Returns:

a T consisting of a list of users, with each user element containing the requested fields.

Throws:

FacebookException

See Also:

http://wiki.developers.facebook.com/index.php/Users.getStandardInfo

photos_uploadWithCaption

public org.w3c.dom.Document photos_uploadWithCaption(java.io.File photo,
                                                     java.lang.String caption)
                                              throws FacebookException

Description copied from interface: IFacebookRestClient

Uploads a photo to Facebook.

Parameters:

photo - an image file

caption - a description of the image contents

Returns:

a T with the standard Facebook photo information

Throws:

FacebookException

See Also:

Developers wiki: Photos.upload

profile_getFBML

@Deprecated
public org.w3c.dom.Document profile_getFBML(int type,
                                                       java.lang.Long userId)
                                     throws FacebookException

Deprecated.

Description copied from interface: IFacebookRestClient

Gets the FBML for the user's profile boxes.

Parameters:

type - The type of profile box to retrieve. Specify 1 for the original style (wide and narrow column boxes), 2 for profile_main box. (Default value is 1.)

userId - The user whose profile FBML is to be fetched, or the page ID in case of a Page. If not specified, defaults to the session user.

Returns:

a T containing FBML markup

Throws:

FacebookException

See Also:

Profile.getFBML

photos_get

public org.w3c.dom.Document photos_get(java.lang.Long subjId,
                                       java.lang.String albumId)
                                throws FacebookException

Description copied from interface: IFacebookRestClient

Used to retrieve photo objects using the search parameters (one or more of the parameters must be provided).

Parameters:

subjId - retrieve from photos associated with this user (optional).

albumId - retrieve from photos from this album (optional)

Returns:

an T of photo objects.

Throws:

FacebookException

See Also:

#photos_get(Long, Long, Collection), Developers Wiki: Photos.get

data_getAssociationDefinition

public org.w3c.dom.Document data_getAssociationDefinition(java.lang.String associationName)
                                                   throws FacebookException

Throws:

FacebookException

data_getObjects

public org.w3c.dom.Document data_getObjects(java.util.Collection<java.lang.Long> objectIds)
                                     throws FacebookException

Throws:

FacebookException

photos_get

public org.w3c.dom.Document photos_get(java.lang.Long subjId)
                                throws FacebookException

Description copied from interface: IFacebookRestClient

Used to retrieve photo objects using the search parameters (one or more of the parameters must be provided).

Parameters:

subjId - retrieve from photos associated with this user (optional).

Returns:

an T of photo objects.

Throws:

FacebookException

See Also:

#photos_get(Long, Long, Collection), Developers Wiki: Photos.get

friends_getList

public org.w3c.dom.Document friends_getList(java.lang.Long friendListId)
                                     throws FacebookException

Description copied from interface: IFacebookRestClient

Retrieves the friends of the currently logged in user that are members of the friends list with ID friendListId.

Parameters:

friendListId - the friend list for which friends should be fetched. if null, all friends will be retrieved.

Throws:

FacebookException

See Also:

http://wiki.developers.facebook.com/index.php/Friends.get

application_getPublicInfoByApiKey

public org.w3c.dom.Document application_getPublicInfoByApiKey(java.lang.String applicationKey)
                                                       throws FacebookException

Description copied from interface: IFacebookRestClient

Gets the public information about the specified application, by API key.

Parameters:

applicationKey - the public API key of the application to get the info for.

Returns:

the public information for the specified application

Throws:

FacebookException

See Also:

http://wiki.developers.facebook.com/index.php/Application.getPublicInfo

events_getMembers

public org.w3c.dom.Document events_getMembers(java.lang.Long eventId)
                                       throws FacebookException

Description copied from interface: IFacebookRestClient

Retrieves the membership list of an event

Parameters:

eventId - The event ID.

Returns:

T consisting of four membership lists corresponding to RSVP status, with keys 'attending', 'unsure', 'declined', and 'not_replied'

Throws:

FacebookException

See Also:

http://wiki.developers.facebook.com/index.php/Events.getMembers

fql_query

public org.w3c.dom.Document fql_query(java.lang.CharSequence query)
                               throws FacebookException

Description copied from interface: IFacebookRestClient

Retrieves the results of a Facebook Query Language query

Parameters:

query - : the FQL query statement

Returns:

varies depending on the FQL query

Throws:

FacebookException

photos_get

public org.w3c.dom.Document photos_get(java.lang.Long subjId,
                                       java.util.Collection<java.lang.String> photoIds)
                                throws FacebookException

Description copied from interface: IFacebookRestClient

Used to retrieve photo objects using the search parameters (one or more of the parameters must be provided).

Parameters:

subjId - retrieve from photos associated with this user (optional).

photoIds - retrieve from this list of photos (optional)

Returns:

an T of photo objects.

Throws:

FacebookException

See Also:

#photos_get(Long, Long, Collection), Developers Wiki: Photos.get

profile_getInfoOptions

@Deprecated
public org.w3c.dom.Document profile_getInfoOptions(java.lang.String field)
                                            throws FacebookException

Deprecated.

Description copied from interface: IFacebookRestClient

Get the options associated with the specified field for an application info section.

Parameters:

field - the field to get the options for.

Returns:

the options associated with the specified field for an application info section.

Throws:

FacebookException

payments_getOrders

public org.w3c.dom.Document payments_getOrders(java.lang.String status,
                                               long startTime,
                                               long endTime)
                                        throws FacebookException

Description copied from interface: IFacebookRestClient

Returns all orders for the given application

Parameters:

status - Return orders with the specified status. Specify one of reserved, settled, or refunded

startTime - Return orders within this time interval

endTime - Return orders within this time interval

Returns:

An array of {order_ids => order_details}. Currently limited by facebook to returning 100,000 orders per query.

Throws:

FacebookException

photos_uploadToAlbum

public org.w3c.dom.Document photos_uploadToAlbum(java.lang.Long userId,
                                                 java.io.File photo,
                                                 java.lang.String albumId)
                                          throws FacebookException

Description copied from interface: IFacebookRestClient

Uploads a photo to Facebook.

Parameters:

userId - the id of the user uploading the photo

photo - an image file

albumId - the album into which the photo should be uploaded

Returns:

a T with the standard Facebook photo information

Throws:

FacebookException

See Also:

Developers wiki: Photos.upload

events_get

public org.w3c.dom.Document events_get(java.lang.Long userId,
                                       java.util.Collection<java.lang.Long> eventIds,
                                       java.lang.Long startTime,
                                       java.lang.Long endTime)
                                throws FacebookException

Description copied from interface: IFacebookRestClient

Returns all visible events according to the filters specified.

Parameters:

userId - Filter by events associated with a user with this uid.

eventIds - Filter by this list of event IDs. This is a comma-separated list of event IDs.

startTime - Filter with this UTC as lower bound. A missing or zero parameter indicates no lower bound.

endTime - Filter with this UTC as upper bound. A missing or zero parameter indicates no upper bound.

Throws:

FacebookException

See Also:

http://wiki.developers.facebook.com/index.php/Events.get

profile_getFBML

@Deprecated
public org.w3c.dom.Document profile_getFBML(int type)
                                     throws FacebookException

Deprecated.

Description copied from interface: IFacebookRestClient

Gets the FBML for the current user's profile boxes.

Parameters:

type - The type of profile box to retrieve. Specify 1 for the original style (wide and narrow column boxes), 2 for profile_main box. (Default value is 1.)

Returns:

a T containing FBML markup

Throws:

FacebookException

See Also:

IFacebookRestClient.profile_getFBML(int, Long)

profile_getFBML

@Deprecated
public org.w3c.dom.Document profile_getFBML(java.lang.Long userId)
                                     throws FacebookException

Deprecated.

Description copied from interface: IFacebookRestClient

Gets the FBML for the user's profile box.

Parameters:

userId - The user whose profile FBML is to be fetched, or the page ID in case of a Page. If not specified, defaults to the session user.

Returns:

a T containing FBML markup

Throws:

FacebookException

See Also:

IFacebookRestClient.profile_getFBML(int, Long)

photos_upload

public org.w3c.dom.Document photos_upload(java.lang.Long userId,
                                          java.lang.String caption,
                                          java.lang.String albumId,
                                          java.lang.String fileName,
                                          java.io.InputStream fileStream)
                                   throws FacebookException

Description copied from interface: IFacebookRestClient

Uploads a photo to Facebook.

Parameters:

userId - the id of the user uploading the photo

caption - a description of the image contents

albumId - the album into which the photo should be uploaded

Returns:

a T with the standard Facebook photo information

Throws:

FacebookException

See Also:

Developers wiki: Photos.upload

friends_areFriends

public org.w3c.dom.Document friends_areFriends(long userId1,
                                               long userId2)
                                        throws FacebookException

Description copied from interface: IFacebookRestClient

Retrieves whether two users are friends.

Throws:

FacebookException

See Also:

http://wiki.developers.facebook.com/index.php/Friends.areFriends

photos_getTags

public org.w3c.dom.Document photos_getTags(java.util.Collection<java.lang.String> photoIds)
                                    throws FacebookException

Description copied from interface: IFacebookRestClient

Retrieves the tags for the given set of photos.

Parameters:

photoIds - The list of photos from which to extract photo tags.

Returns:

the created album

Throws:

FacebookException

photos_upload

public org.w3c.dom.Document photos_upload(java.lang.Long userId,
                                          java.io.File photo)
                                   throws FacebookException

Description copied from interface: IFacebookRestClient

Uploads a photo to Facebook.

Parameters:

userId - the id of the user uploading the photo

photo - an image file

Returns:

a T with the standard Facebook photo information

Throws:

FacebookException

See Also:

Developers wiki: Photos.upload

photos_createAlbum

public org.w3c.dom.Document photos_createAlbum(java.lang.String albumName,
                                               java.lang.Long userId)
                                        throws FacebookException

Description copied from interface: IFacebookRestClient

Creates an album.

Parameters:

albumName - The list of photos from which to extract photo tags.

userId - the id of the user creating the album.

Returns:

the created album

Throws:

FacebookException

photos_getByAlbum

public org.w3c.dom.Document photos_getByAlbum(java.lang.String albumId)
                                       throws FacebookException

Description copied from interface: IFacebookRestClient

Used to retrieve photo objects using the search parameters (one or more of the parameters must be provided).

Parameters:

albumId - retrieve from photos from this album (optional)

Returns:

an T of photo objects.

Throws:

FacebookException

See Also:

#photos_get(Integer, Long, Collection), Developers Wiki: Photos.get

feed_getRegisteredTemplateBundles

@Deprecated
public org.w3c.dom.Document feed_getRegisteredTemplateBundles()
                                                       throws FacebookException

Deprecated.

Description copied from interface: IFacebookRestClient

Get a list of all registered template bundles for your application.

Returns:

a list describing all registered feed templates.

Throws:

FacebookException

application_getPublicInfo

public org.w3c.dom.Document application_getPublicInfo(java.lang.Long applicationId,
                                                      java.lang.String applicationKey,
                                                      java.lang.String applicationCanvas)
                                               throws FacebookException

Description copied from interface: IFacebookRestClient

Gets the public information about the specified application. Only one of the 3 parameters needs to be specified.

Parameters:

applicationId - the id of the application to get the info for.

applicationKey - the public API key of the application to get the info for.

applicationCanvas - the canvas-page name of the application to get the info for.

Returns:

the public information for the specified application

Throws:

FacebookException

See Also:

http://wiki.developers.facebook.com/index.php/Application.getPublicInfo

photos_getAlbums

public org.w3c.dom.Document photos_getAlbums(java.lang.Long userId,
                                             java.util.Collection<java.lang.String> albumIds)
                                      throws FacebookException

Description copied from interface: IFacebookRestClient

Retrieves album metadata. Pass a user id and/or a list of album ids to specify the albums to be retrieved (at least one must be provided)

Parameters:

userId - (optional) the id of the albums' owner (optional)

albumIds - (optional) the ids of albums whose metadata is to be retrieved

Returns:

album objects

Throws:

FacebookException

See Also:

Developers Wiki: Photos.getAlbums

friends_getMutualFriends

public org.w3c.dom.Document friends_getMutualFriends(java.lang.Long targetId)
                                              throws FacebookException

Description copied from interface: IFacebookRestClient

Returns the Facebook user IDs of the mutual friends between the source user and target user. For the source user, you can either specify the source's user ID (the source_id) or use the session key of the logged-in user, but not specify both.

Throws:

FacebookException

See Also:

http://wiki.developers.facebook.com/index.php/Friends.getMutualFriends

pages_getInfo

public org.w3c.dom.Document pages_getInfo(java.util.Collection<java.lang.Long> pageIds,
                                          java.util.Collection<PageProfileField> fields)
                                   throws FacebookException

Description copied from interface: IFacebookRestClient

Retrieves the requested profile fields for the Facebook Pages with the given pageIds. Can be called for pages that have added the application without establishing a session.

Parameters:

pageIds - the page IDs

fields - a set of page profile fields

Returns:

a T consisting of a list of pages, with each page element containing the requested fields.

Throws:

FacebookException

See Also:

Developers Wiki: Pages.getInfo

dashboard_multiClearNews

public org.w3c.dom.Document dashboard_multiClearNews(java.util.Collection<java.lang.Long> userIds)
                                              throws FacebookException

Description copied from interface: IFacebookRestClient

Clears all of the news items associated to the specified users.

Throws:

FacebookException

See Also:

#dashboard_multiClearNews(Map>)

data_getAssociationDefinitions

public org.w3c.dom.Document data_getAssociationDefinitions()
                                                    throws FacebookException

Throws:

FacebookException

groups_getMembers

public org.w3c.dom.Document groups_getMembers(java.lang.Number groupId)
                                       throws FacebookException

Description copied from interface: IFacebookRestClient

Retrieves the membership list of a group

Parameters:

groupId - the group id

Returns:

a T containing four membership lists of 'members', 'admins', 'officers', and 'not_replied'

Throws:

FacebookException

connect_registerUsers

public org.w3c.dom.Document connect_registerUsers(java.util.Collection<java.util.Map<java.lang.String,java.lang.String>> accounts)
                                           throws FacebookException

Description copied from interface: IFacebookRestClient

This method is used to create an association between an external user account and a Facebook user account. This method takes an array of account data, including a required email_hash and optional account data. For each connected account, if the user exists, the information is added to the set of the user's connected accounts. If the user has already authorized the site, the connected account is added in the confirmed state. If the user has not yet authorized the site, the connected account is added in the pending state.

Parameters:

accounts - An array of up to 1,000 arrays, or "maps," where each map represent a connected account. Each map can have the following properties:

• email_hash: The public email hash of remote account. This property is required. Compute the email_hash property as follows:
  1. Normalize the email address. Trim leading and trailing whitespace, and convert all characters to lowercase.
  2. Compute the CRC32 value for the normalized email address and use the unsigned integer representation of this value. (Note that some implementations return signed integers, in which case you will need to convert that result to an unsigned integer.)
  3. Compute the MD5 value for the normalized email address and use the hex representation of this value (using lowercase for A through F).
  4. Combine these two value with an underscore.
  For example, the address mary@example.com converts to 4228600737_c96da02bba97aedfd26136e980ae3761.
• account_id: The user's account ID on the Facebook Connect site. This property is optional. If you specify the account_id property, then you must also set a Connect Preview URL in your application's settings in order to generate a full user URL. The Connect Preview URL contains an account_id parameter, such as http://www.example.com/profile.php?user=account_id.
• account_url: The URL to the user's account on the Facebook Connect site. This property is optional. If you specify the account_url property, that URL will be used directly.

Facebook recommends that you specify at least one of either the account_id or the account_url properties.

Returns:

This method returns an array of email hashes that have been successfully registered. If any email hashes are missing, we recommend that you try registering them again later.

Throws:

FacebookException

See Also:

http://wiki.developers.facebook.com/index.php/Connect.registerUsers

profile_getInfo

@Deprecated
public org.w3c.dom.Document profile_getInfo(java.lang.Long userId)
                                     throws FacebookException

Deprecated.

Description copied from interface: IFacebookRestClient

Get the specified user's application-info section.

Parameters:

userId - the id of the user to get the info section for.

Returns:

the user's application-info section.

Throws:

FacebookException

photos_getAlbums

public org.w3c.dom.Document photos_getAlbums(java.util.Collection<java.lang.String> albumIds)
                                      throws FacebookException

Description copied from interface: IFacebookRestClient

Retrieves album metadata for a list of album IDs.

Parameters:

albumIds - the ids of albums whose metadata is to be retrieved

Returns:

album objects

Throws:

FacebookException

See Also:

Developers Wiki: Photos.getAlbums

friends_areFriends

public org.w3c.dom.Document friends_areFriends(java.util.Collection<java.lang.Long> userIds1,
                                               java.util.Collection<java.lang.Long> userIds2)
                                        throws FacebookException

Description copied from interface: IFacebookRestClient

Retrieves whether pairs of users are friends. Returns whether the first user in userIds1 is friends with the first user in userIds2, the second user in userIds1 is friends with the second user in userIds2, etc.

Throws:

FacebookException

See Also:

http://wiki.developers.facebook.com/index.php/Friends.areFriends

data_getCookies

public org.w3c.dom.Document data_getCookies(java.lang.String name)
                                     throws FacebookException

Description copied from interface: IFacebookRestClient

Get a specific cookie for the currently logged-in user.

Parameters:

name - the name of the cookie to retrieve.

Returns:

the specified cookie for the current user.

Throws:

FacebookException

admin_getDailyMetrics

@Deprecated
public org.w3c.dom.Document admin_getDailyMetrics(java.util.Set<Metric> metrics,
                                                             long start,
                                                             long end)
                                           throws FacebookException

Deprecated.

Description copied from interface: IFacebookRestClient

Retrieve the daily metrics for the current application.

Parameters:

metrics - a set specifying the specific metrics to retrieve

start - the starting date to retrieve data for (range must not exceed 30 days), the accepted unit of time is milliseconds, NOT seconds

end - the ending to to retrive data for (range must not exceed 30 days), the accepted unit of time is milliseconds, NOT seconds

Returns:

daily metrics for your app, for each day in the specified range

Throws:

FacebookException

See Also:

http://wiki.developers.facebook.com/index.php/Admin.getDailyMetrics

friends_getMutualFriends

public org.w3c.dom.Document friends_getMutualFriends(java.lang.Long sourceId,
                                                     java.lang.Long targetId)
                                              throws FacebookException

Description copied from interface: IFacebookRestClient

Returns the Facebook user IDs of the mutual friends between the source user and target user. For the source user, you can either specify the source's user ID (the source_id) or use the session key of the logged-in user, but not specify both.

Throws:

FacebookException

See Also:

http://wiki.developers.facebook.com/index.php/Friends.getMutualFriends

notifications_get

@Deprecated
public org.w3c.dom.Document notifications_get()
                                       throws FacebookException

Deprecated.

Description copied from interface: IFacebookRestClient

Retrieves the outstanding notifications for the session user.

Returns:

a T containing notification count pairs for 'messages', 'pokes' and 'shares', a uid list of 'friend_requests', a gid list of 'group_invites', and an eid list of 'event_invites'

Throws:

FacebookException

users_getStandardInfo

public org.w3c.dom.Document users_getStandardInfo(java.util.Collection<java.lang.Long> userIds,
                                                  java.util.Set<java.lang.CharSequence> fields)
                                           throws FacebookException

Description copied from interface: IFacebookRestClient

Returns an array of user-specific information for each user identifier passed, limited by the view of the current user. The information you can get from this call is limited to: uid, first_name, last_name, name, timezone, birthday, sex, affiliations (regional type only)

Parameters:

userIds - a collection of user IDs for which to fetch info

fields - a set of strings describing the info fields desired, such as "last_name", "sex"

Returns:

a T consisting of a list of users, with each user element containing the requested fields.

Throws:

FacebookException

See Also:

http://wiki.developers.facebook.com/index.php/Users.getStandardInfo

dashboard_multiClearNews

public org.w3c.dom.Document dashboard_multiClearNews(java.util.Map<java.lang.Long,java.util.Collection<java.lang.Long>> userIdToNewsIdsMap)
                                              throws FacebookException

Description copied from interface: IFacebookRestClient

Removes the referenced news items against each of the users specified.

Returns:

Set of user ids for which the operation was successful.

Throws:

FacebookException

pages_getInfo

public org.w3c.dom.Document pages_getInfo(java.lang.Long userId,
                                          java.util.Collection<PageProfileField> fields)
                                   throws FacebookException

Description copied from interface: IFacebookRestClient

Retrieves the requested profile fields for the Facebook Pages of the user with the given userId.

Parameters:

userId - the ID of a user about whose pages to fetch info

fields - a set of PageProfileFields

Returns:

a T consisting of a list of pages, with each page element containing the requested fields.

Throws:

FacebookException

See Also:

Developers Wiki: Pages.getInfo

friends_getLists

public org.w3c.dom.Document friends_getLists()
                                      throws FacebookException

Description copied from interface: IFacebookRestClient

Retrieves the friend lists of the currently logged in user.

Throws:

FacebookException

See Also:

http://wiki.developers.facebook.com/index.php/Friends.getLists

photos_createAlbum

public org.w3c.dom.Document photos_createAlbum(java.lang.String name,
                                               java.lang.String description,
                                               java.lang.String location)
                                        throws FacebookException

Description copied from interface: IFacebookRestClient

Creates an album.

Parameters:

name - The album name.

description - The album description (optional).

location - The album location (optional).

Returns:

an array of photo objects.

Throws:

FacebookException

groups_get

public org.w3c.dom.Document groups_get(java.lang.Long userId,
                                       java.util.Collection<java.lang.Long> groupIds)
                                throws FacebookException

Description copied from interface: IFacebookRestClient

Retrieves the groups associated with a user

Parameters:

userId - Optional: User associated with groups. A null parameter will default to the session user.

groupIds - Optional: group ids to query. A null parameter will get all groups for the user.

Returns:

array of groups

Throws:

FacebookException

photos_getAlbums

public org.w3c.dom.Document photos_getAlbums(java.lang.Long userId)
                                      throws FacebookException

Description copied from interface: IFacebookRestClient

Retrieves album metadata for albums owned by a user.

Parameters:

userId - (optional) the id of the albums' owner (optional)

Returns:

album objects

Throws:

FacebookException

See Also:

Developers Wiki: Photos.getAlbums

application_getPublicInfoById

public org.w3c.dom.Document application_getPublicInfoById(java.lang.Long applicationId)
                                                   throws FacebookException

Description copied from interface: IFacebookRestClient

Gets the public information about the specified application, by application id.

Parameters:

applicationId - the id of the application to get the info for.

Returns:

the public information for the specified application

Throws:

FacebookException

See Also:

http://wiki.developers.facebook.com/index.php/Application.getPublicInfo

data_getCookies

public org.w3c.dom.Document data_getCookies(java.lang.Long userId)
                                     throws FacebookException

Description copied from interface: IFacebookRestClient

Get all cookies for the specified user.

Parameters:

userId - the id of the user to get the cookies for.

Returns:

all cookies for the specified user.

Throws:

FacebookException

pages_getInfo

public org.w3c.dom.Document pages_getInfo(java.lang.Long userId,
                                          java.util.Set<java.lang.CharSequence> fields)
                                   throws FacebookException

Description copied from interface: IFacebookRestClient

Retrieves the requested profile fields for the Facebook Pages of the user with the given userId.

Parameters:

userId - the ID of a user about whose pages to fetch info

fields - a set of page profile fields

Returns:

a T consisting of a list of pages, with each page element containing the requested fields.

Throws:

FacebookException

See Also:

Developers Wiki: Pages.getInfo

photos_createAlbum

public org.w3c.dom.Document photos_createAlbum(java.lang.String albumName)
                                        throws FacebookException

Description copied from interface: IFacebookRestClient

Creates an album.

Parameters:

albumName - The list of photos from which to extract photo tags.

Returns:

the created album

Throws:

FacebookException

stream_getFilters

public org.w3c.dom.Document stream_getFilters(java.lang.Long userId)
                                       throws FacebookException

Throws:

FacebookException

connect_unregisterUsers

public org.w3c.dom.Document connect_unregisterUsers(java.util.Collection<java.lang.String> email_hashes)
                                             throws FacebookException

Description copied from interface: IFacebookRestClient

This method allows a site to unregister a previously registered account (using connect.registerUsers). You should call this method if the user deletes his account on your site.

Parameters:

email_hashes - An array of email_hashes to unregister.

Returns:

This method returns an array of unregistered email hashes. If any email hashes are missing, we recommend that you try unregistering the account again later.

Throws:

FacebookException

See Also:

http://wiki.developers.facebook.com/index.php/Connect.unregisterUsers

admin_getMetrics

public org.w3c.dom.Document admin_getMetrics(java.util.Set<Metric> metrics,
                                             long start,
                                             long end,
                                             long period)
                                      throws FacebookException

Description copied from interface: IFacebookRestClient

Retrieve the daily metrics for the current application.

Parameters:

metrics - a set specifying the specific metrics to retrieve

start - the starting date to retrieve data for (range must not exceed 30 days), the accepted unit of time is milliseconds, NOT seconds

end - the ending to to retrive data for (range must not exceed 30 days), the accepted unit of time is milliseconds, NOT seconds

period - a number specifying the desired period to group the metrics by, in seconds, Facebook currently only supports Metric.PERIOD_DAY, Metric.PERIOD_WEEK, and Metric.PERIOD_MONTH

Returns:

daily metrics for your app, for each day in the specified range

Throws:

FacebookException

See Also:

http://wiki.developers.facebook.com/index.php/Admin.getMetrics

events_get

public org.w3c.dom.Document events_get(java.lang.Long userId,
                                       java.util.Collection<java.lang.Long> eventIds,
                                       java.lang.Long startTime,
                                       java.lang.Long endTime,
                                       java.lang.String rsvp_status)
                                throws FacebookException

Description copied from interface: IFacebookRestClient

Returns all visible events according to the filters specified.

Parameters:

userId - Filter by events associated with a user with this uid.

eventIds - Filter by this list of event IDs. This is a comma-separated list of event IDs.

startTime - Filter with this UTC as lower bound. A missing or zero parameter indicates no lower bound.

endTime - Filter with this UTC as upper bound. A missing or zero parameter indicates no upper bound.

rsvp_status - Filter by this RSVP status. The RSVP status should be one of the following strings: attending, unsure, declined, not_replied

Throws:

FacebookException

See Also:

http://wiki.developers.facebook.com/index.php/Events.get

users_getInfo

public org.w3c.dom.Document users_getInfo(java.lang.Iterable<java.lang.Long> userIds,
                                          java.util.Set<java.lang.CharSequence> fields)
                                   throws FacebookException

Description copied from interface: IFacebookRestClient

Retrieves the requested info fields for the requested set of users.

Parameters:

userIds - a collection of user IDs for which to fetch info

fields - a set of strings describing the info fields desired, such as "last_name", "sex"

Returns:

a T consisting of a list of users, with each user element containing the requested fields.

Throws:

FacebookException

See Also:

http://wiki.developers.facebook.com/index.php/Users.getInfo

photos_uploadToAlbum

public org.w3c.dom.Document photos_uploadToAlbum(java.io.File photo,
                                                 java.lang.String albumId)
                                          throws FacebookException

Description copied from interface: IFacebookRestClient

Uploads a photo to Facebook.

Parameters:

photo - an image file

albumId - the album into which the photo should be uploaded

Returns:

a T with the standard Facebook photo information

Throws:

FacebookException

See Also:

Developers wiki: Photos.upload

batch_run

public org.w3c.dom.Document batch_run(java.lang.String methods,
                                      boolean serial)
                               throws FacebookException

Description copied from interface: IFacebookRestClient

Executes a batch of queries. It is your responsibility to encode the method feed correctly. It is not recommended that you call this method directly. Instead use 'beginBatch' and 'executeBatch', which will take care of the hard parts for you.

Parameters:

methods - A JSON encoded array of strings. Each element in the array should contain the full parameters for a method, including method name, sig, etc. Currently, there is a maximum limit of 15 elements in the array.

serial - An optional parameter to indicate whether the methods in the method_feed must be executed in order. The default value is false.

Returns:

a result containing the response to each individual query in the batch.

Throws:

FacebookException

photos_get

public org.w3c.dom.Document photos_get(java.lang.Long subjId,
                                       java.lang.String albumId,
                                       java.util.Collection<java.lang.String> photoIds)
                                throws FacebookException

Description copied from interface: IFacebookRestClient

Used to retrieve photo objects using the search parameters (one or more of the parameters must be provided).

Parameters:

subjId - retrieve from photos associated with this user (optional).

albumId - retrieve from photos from this album (optional)

photoIds - retrieve from this list of photos (optional)

Returns:

an T of photo objects.

Throws:

FacebookException

photos_getByAlbum

public org.w3c.dom.Document photos_getByAlbum(java.lang.String albumId,
                                              java.util.Collection<java.lang.String> photoIds)
                                       throws FacebookException

Description copied from interface: IFacebookRestClient

Used to retrieve photo objects using the search parameters (one or more of the parameters must be provided).

Parameters:

albumId - retrieve from photos from this album (optional)

photoIds - retrieve from this list of photos (optional)

Returns:

an T of photo objects.

Throws:

FacebookException

See Also:

#photos_get(Integer, Long, Collection), Developers Wiki: Photos.get

application_getPublicInfoByCanvasName

public org.w3c.dom.Document application_getPublicInfoByCanvasName(java.lang.String applicationCanvas)
                                                           throws FacebookException

Description copied from interface: IFacebookRestClient

Gets the public information about the specified application, by canvas-page name.

Parameters:

applicationCanvas - the canvas-page name of the application to get the info for.

Returns:

the public information for the specified application

Throws:

FacebookException

See Also:

http://wiki.developers.facebook.com/index.php/Application.getPublicInfo