IFacebookRestClient (Facebook Java Library 3.0.4 API)

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.google.code.facebookapi
Interface IFacebookRestClient<T>

All Known Implementing Classes:: ExtensibleClient, FacebookJaxbRestClient, FacebookJaxbRestClientBase, FacebookJsonRestClient, FacebookJsonRestClientBase, FacebookXmlRestClient, FacebookXmlRestClientBase, SpecificReturnTypeAdapter

public interface IFacebookRestClient<T>

Generic interface for a FacebookRestClient, parameterized by output format. For continually updated documentation, please refer to the Developer Wiki.

Field Summary
`static java.lang.String`	`ERROR_TAG`
`static java.lang.String`	`TARGET_API_VERSION`

Method Summary
`int`	`admin_getAllocation(AllocationType allocationType)` Get your application's current allocation of the specified type of request (i.e.
`int`	`admin_getAllocation(AllocationType allocationType, java.lang.Long userId)` Get your application's current allocation of the specified type of request (i.e.
`int`	`admin_getAllocation(java.lang.String allocationType)` Get your application's current allocation of the specified type of request (i.e.
`int`	`admin_getAllocation(java.lang.String allocationType, java.lang.Long userId)` Get your application's current allocation of the specified type of request (i.e.
`org.json.JSONObject`	`admin_getAppProperties(java.util.Collection<ApplicationProperty> properties)` Deprecated. use admin_getAppPropertiesMap() instead
`ApplicationPropertySet`	`admin_getAppPropertiesAsSet(java.util.Collection<ApplicationProperty> properties)` Gets property values previously set for an application on either the Facebook Developer application or the with the `admin.setAppProperties` call.
`java.lang.String`	`admin_getAppPropertiesAsString(java.util.Collection<ApplicationProperty> properties)` Retrieve application properties.
`java.util.Map<ApplicationProperty,java.lang.String>`	`admin_getAppPropertiesMap(java.util.Collection<ApplicationProperty> properties)` Retrieve application properties.
`T`	`admin_getDailyMetrics(java.util.Set<Metric> metrics, java.util.Date start, java.util.Date end)` Deprecated.
`T`	`admin_getDailyMetrics(java.util.Set<Metric> metrics, long start, long end)` Deprecated.
`T`	`admin_getMetrics(java.util.Set<Metric> metrics, java.util.Date start, java.util.Date end, long period)` Retrieve metrics for the current application.
`T`	`admin_getMetrics(java.util.Set<Metric> metrics, long start, long end, long period)` Retrieve the daily metrics for the current application.
`int`	`admin_getNotificationAllocation()` Deprecated.
`int`	`admin_getRequestAllocation()` Deprecated.
`boolean`	`admin_setAppProperties(ApplicationPropertySet properties)` Sets several property values for an application.
`boolean`	`admin_setAppProperties(java.util.Map<ApplicationProperty,java.lang.String> properties)` Set application properties.
`T`	`application_getPublicInfo(java.lang.Long applicationId, java.lang.String applicationKey, java.lang.String applicationCanvas)` Gets the public information about the specified application.
`T`	`application_getPublicInfoByApiKey(java.lang.String applicationKey)` Gets the public information about the specified application, by API key.
`T`	`application_getPublicInfoByCanvasName(java.lang.String applicationCanvas)` Gets the public information about the specified application, by canvas-page name.
`T`	`application_getPublicInfoById(java.lang.Long applicationId)` Gets the public information about the specified application, by application id.
`java.lang.String`	`auth_createToken()` Call this function and store the result, using it to generate the appropriate login url and then to retrieve the session information.
`boolean`	`auth_expireSession()` Expires the curently active session.
`java.lang.String`	`auth_getSession(java.lang.String authToken)` Call this function to retrieve the session information after your user has logged in.
`java.lang.String`	`auth_getSession(java.lang.String authToken, boolean generateSessionSecret)` Call this function to retrieve the session information after your user has logged in.
`java.lang.String`	`auth_promoteSession()` Generate a key for the current session that can be used to authenticate client-side components.
`boolean`	`auth_revokeAuthorization()` If this method is called for the logged in user, then no further API calls can be made on that user's behalf until the user decides to authorize the application again.
`boolean`	`auth_revokeExtendedPermission(Permission perm)`
`boolean`	`auth_revokeExtendedPermission(Permission perm, java.lang.Long userId)` Revokes the specified extended permission for the selected user.
`T`	`batch_run(java.lang.String methods, boolean serial)` Executes a batch of queries.
`void`	`beginBatch()` Starts a batch of queries.
`void`	`beginPermissionsMode(java.lang.String apiKey)` Begins permissions mode, and allows the current application to begin making requests on behalf of the application associated with the specified API key.
`int`	`connect_getUnconnectedFriendsCount()` This method returns the number of friends of the current user who have accounts on your site, but have not yet connected their accounts.
`T`	`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.
`T`	`connect_unregisterUsers(java.util.Collection<java.lang.String> email_hashes)` This method allows a site to unregister a previously registered account (using connect.registerUsers).
`java.lang.Long`	`dashboard_addGlobalNews(java.util.Collection<DashboardNewsItem> newsItems)` Non-imageUrl method signature form.
`java.lang.Long`	`dashboard_addGlobalNews(java.util.Collection<DashboardNewsItem> newsItems, java.lang.String imageUrl)` Submits global news items for all users of the app.
`boolean`	`dashboard_clearGlobalNews()` Clears all global news items from application.
`boolean`	`dashboard_clearGlobalNews(java.util.Collection<java.lang.Long> newsIds)` Clears specific global news items from application.
`T`	`dashboard_multiAddNews(java.util.Collection<java.lang.Long> userIds, java.util.Collection<DashboardNewsItem> newsItems)` Non-imageUrl method signature form.
`T`	`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.
`T`	`dashboard_multiClearNews(java.util.Collection<java.lang.Long> userIds)` Clears all of the news items associated to the specified users.
`T`	`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.
`java.util.Set<java.lang.Long>`	`dashboard_multiIncrementCount(java.util.Collection<java.lang.Long> userIds)` Increments the dashboard bookmark counter by one for the given set of users.
`java.lang.Long`	`dashboard_publishActivity(DashboardActivityItem activityItem)` Non-imageUrl method signature form.
`java.lang.Long`	`dashboard_publishActivity(DashboardActivityItem activityItem, java.lang.String imageUrl)` Submits activity for a given user as it will appear in the dashboard section, 'what your friends are doing'.
`long`	`data_createObject(java.lang.String objectType, java.util.Map<java.lang.String,java.lang.String> properties)` Create object in Data Store
`void`	`data_createObjectType(java.lang.String name)` An object type is like a "table" in SQL terminology, or a "class" in object-oriented programming concepts.
`void`	`data_defineAssociation(java.lang.String associationName, AssociationType associationType, AssociationInfo associationInfo1, AssociationInfo associationInfo2, java.lang.String inverseName)`
`void`	`data_defineObjectProperty(java.lang.String objectType, java.lang.String propertyName, PropertyType propertyType)`
`void`	`data_deleteObject(long objectId)` Delete object in Data Store
`void`	`data_deleteObjects(java.util.Collection<java.lang.Long> objectIds)` Delete multiple objects in Data Store WARNING: This method seems to fail when it comes across the first object that it can't find.
`void`	`data_dropObjectType(java.lang.String objectType)` Remove a previously defined object type.
`long`	`data_getAssociatedObjectCount(java.lang.String associationName, long objectId)` Returns count of object ids that are associated with specified object.
`T`	`data_getAssociationDefinition(java.lang.String associationName)`
`T`	`data_getAssociationDefinitions()`
`T`	`data_getCookies()` Get all cookies for the currently logged-in user.
`T`	`data_getCookies(java.lang.Long userId)` Get all cookies for the specified user.
`T`	`data_getCookies(java.lang.Long userId, java.lang.CharSequence name)` Get a specific cookie for the specified user.
`T`	`data_getCookies(java.lang.String name)` Get a specific cookie for the currently logged-in user.
`T`	`data_getObject(long objectId)`
`T`	`data_getObjectProperty(long objectId, java.lang.String propertyName)`
`T`	`data_getObjects(java.util.Collection<java.lang.Long> objectIds)`
`T`	`data_getObjectType(java.lang.String objectType)`
`T`	`data_getObjectTypes()`
`java.lang.String`	`data_getUserPreference(int prefId)` Lookup a single preference value for the current user.
`T`	`data_getUserPreferences()` Get a map containing all preference values set for the current user.
`void`	`data_removeAssociatedObjects(java.lang.String associationName, long objectId)` The name of this function may be misleading, but it actually removes associations between any other objects and a specified object.
`void`	`data_removeAssociation(java.lang.String associationName, long object1Id, long object2Id)` Removes an association between two object identifiers.
`void`	`data_renameAssociation(java.lang.String name, java.lang.String newName, java.lang.String newAlias1, java.lang.String newAlias2)` Rename a previously defined association.
`void`	`data_renameObjectProperty(java.lang.String objectType, java.lang.String propertyName, java.lang.String newPropertyName)`
`void`	`data_renameObjectType(java.lang.String name, java.lang.String newName)`
`void`	`data_setAssociation(java.lang.String associationName, long object1Id, long object2Id, java.lang.String data, java.util.Date associationTime)` Create an association between two objects
`boolean`	`data_setCookie(java.lang.Long userId, java.lang.CharSequence name, java.lang.CharSequence value)` Set a cookie for the specified user.
`boolean`	`data_setCookie(java.lang.Long userId, java.lang.CharSequence name, java.lang.CharSequence value, java.lang.CharSequence path)` Set a cookie for the specified user, with the specified path.
`boolean`	`data_setCookie(java.lang.Long userId, java.lang.CharSequence name, java.lang.CharSequence value, java.lang.Long expires)` Set a cookie for the specified user, with the specified expiration date.
`boolean`	`data_setCookie(java.lang.Long userId, java.lang.CharSequence name, java.lang.CharSequence value, java.lang.Long expires, java.lang.CharSequence path)` Set a cookie for the specified user, with the specified expiration date and path.
`boolean`	`data_setCookie(java.lang.String name, java.lang.String value)` Set a cookie for the current user.
`boolean`	`data_setCookie(java.lang.String name, java.lang.String value, java.lang.Long expires)` Set a cookie for the current user, with the specified expiration date.
`boolean`	`data_setCookie(java.lang.String name, java.lang.String value, java.lang.Long expires, java.lang.String path)` Set a cookie for the current user, with the specified expiration date and path.
`boolean`	`data_setCookie(java.lang.String name, java.lang.String value, java.lang.String path)` Set a cookie for the current user, under the specified path.
`void`	`data_setObjectProperty(long objectId, java.lang.String propertyName, java.lang.String value)`
`void`	`data_setUserPreference(int prefId, java.lang.String value)` Set a user-preference value.
`void`	`data_setUserPreferences(java.util.Map<java.lang.Integer,java.lang.String> values, boolean replace)` Set multiple user-preferences values.
`void`	`data_undefineAssociation(java.lang.String name)` Remove a previously defined association.
`void`	`data_undefineObjectProperty(java.lang.String objectType, java.lang.String propertyName)`
`void`	`data_updateObject(long objectId, java.util.Map<java.lang.String,java.lang.String> properties, boolean replace)` Update properties of an existing object in Data Store
`void`	`endPermissionsMode()` Terminates permissions mode.
`boolean`	`events_cancel(java.lang.Long eid, java.lang.String cancel_message)` Cancels an event.
`java.lang.Long`	`events_create(java.util.Map<java.lang.String,java.lang.String> event_info)` Creates an event on behalf of the user if the application has an active session key for that user; otherwise it creates an event on behalf of the application.
`boolean`	`events_edit(java.lang.Long eid, java.util.Map<java.lang.String,java.lang.String> event_info)` Edits the details of an existing event.
`T`	`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.
`T`	`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.
`T`	`events_getMembers(java.lang.Long eventId)` Retrieves the membership list of an event
`boolean`	`events_rsvp(java.lang.Long eid, java.lang.String rsvp_status)` Sets a user's RSVP status for an event.
`java.util.List<? extends java.lang.Object>`	`executeBatch(boolean serial)` Executes a batch of queries.
`void`	`fbml_deleteCustomTags(java.util.Collection<java.lang.String> names)` Deletes one or more custom tags you previously registered for the calling application with fbml.registerCustomTags.
`T`	`fbml_getCustomTags(java.lang.String appId)` Returns the custom tag definitions for tags that were previously defined using fbml.registerCustomTags.
`boolean`	`fbml_refreshImgSrc(java.lang.String imageUrl)` Recaches the image with the specified imageUrl.
`boolean`	`fbml_refreshImgSrc(java.net.URL imageUrl)` Recaches the image with the specified imageUrl.
`boolean`	`fbml_refreshRefUrl(java.lang.String url)` Recaches the referenced url.
`boolean`	`fbml_refreshRefUrl(java.net.URL url)` Recaches the referenced url.
`void`	`fbml_registerCustomTags(java.util.Collection<org.json.JSONObject> tags)` Registers custom tags you can include in your that applications' FBML markup.
`boolean`	`fbml_setRefHandle(java.lang.String handle, java.lang.String markup)` Associates the specified FBML markup with the specified handle/id.
`boolean`	`feed_deactivateTemplateBundleByID(java.lang.Long bundleId)` Deprecated.
`T`	`feed_getRegisteredTemplateBundleByID(java.lang.Long id)` Deprecated.
`T`	`feed_getRegisteredTemplateBundles()` Deprecated.
`boolean`	`feed_publishTemplatizedAction(java.lang.CharSequence titleTemplate)` Deprecated.
`boolean`	`feed_publishTemplatizedAction(java.lang.CharSequence titleTemplate, java.lang.Long pageActorId)` Deprecated.
`boolean`	`feed_publishTemplatizedAction(java.lang.CharSequence titleTemplate, java.util.Map<java.lang.String,java.lang.CharSequence> titleData, java.lang.CharSequence bodyTemplate, java.util.Map<java.lang.String,java.lang.CharSequence> bodyData, java.lang.CharSequence bodyGeneral, java.util.Collection<java.lang.Long> targetIds, java.util.Collection<? extends IPair<? extends java.lang.Object,java.net.URL>> images, java.lang.Long pageActorId)` Deprecated.
`boolean`	`feed_publishTemplatizedAction(java.lang.Integer actorId, java.lang.CharSequence titleTemplate, java.util.Map<java.lang.String,java.lang.CharSequence> titleData, java.lang.CharSequence bodyTemplate, java.util.Map<java.lang.String,java.lang.CharSequence> bodyData, java.lang.CharSequence bodyGeneral, java.util.Collection<java.lang.Long> targetIds, java.util.Collection<? extends IPair<? extends java.lang.Object,java.net.URL>> images)` Deprecated. use the version that specified the actorId as a Long instead. UID's are not ever to be* expressed as Integers.*
`boolean`	`feed_publishTemplatizedAction(java.lang.Long actorId, java.lang.CharSequence titleTemplate)` Deprecated. since 01/18/2008
`boolean`	`feed_publishTemplatizedAction(java.lang.Long actorId, java.lang.CharSequence titleTemplate, java.util.Map<java.lang.String,java.lang.CharSequence> titleData, java.lang.CharSequence bodyTemplate, java.util.Map<java.lang.String,java.lang.CharSequence> bodyData, java.lang.CharSequence bodyGeneral, java.util.Collection<java.lang.Long> targetIds, java.util.Collection<? extends IPair<? extends java.lang.Object,java.net.URL>> images)` Deprecated.
`boolean`	`feed_publishTemplatizedAction(java.lang.String titleTemplate, java.lang.String titleData, java.lang.String bodyTemplate, java.lang.String bodyData, java.lang.String bodyGeneral, java.util.Collection<? extends IPair<? extends java.lang.Object,java.net.URL>> pictures, java.lang.String targetIds)` Deprecated.
`boolean`	`feed_PublishTemplatizedAction(TemplatizedAction action)` Deprecated.
`java.lang.Boolean`	`feed_publishUserAction(java.lang.Long bundleId)` Deprecated.
`java.lang.Boolean`	`feed_publishUserAction(java.lang.Long bundleId, java.util.Map<java.lang.String,java.lang.String> templateData, java.util.List<IFeedImage> images, java.util.List<java.lang.Long> targetIds, java.lang.String bodyGeneral, int storySize)` Deprecated.
`java.lang.Boolean`	`feed_publishUserAction(java.lang.Long bundleId, java.util.Map<java.lang.String,java.lang.String> templateData, java.util.List<java.lang.Long> targetIds, java.lang.String bodyGeneral)` Deprecated.
`java.lang.Long`	`feed_registerTemplateBundle(java.util.Collection<java.lang.String> templates)` Deprecated.
`java.lang.Long`	`feed_registerTemplateBundle(java.util.Collection<java.lang.String> templates, java.util.Collection<BundleStoryTemplate> shortTemplates, BundleStoryTemplate longTemplate)` Deprecated.
`java.lang.Long`	`feed_registerTemplateBundle(java.util.Collection<java.lang.String> templates, java.util.Collection<BundleStoryTemplate> shortTemplates, BundleStoryTemplate longTemplate, java.util.List<BundleActionLink> actionLinks)` Deprecated.
`java.lang.Long`	`feed_registerTemplateBundle(java.lang.String template)` Deprecated.
`java.lang.Long`	`feed_registerTemplateBundle(java.lang.String template, java.lang.String shortTemplate, java.lang.String longTemplate)` Deprecated. Facebook has greatly modified the syntax required for the 'shortTemplate' and 'longTemplate' parameters. As such this method will now ignore those parameters. You are encouraged to use one of the alternate versions.
`T`	`fql_query(java.lang.CharSequence query)` Retrieves the results of a Facebook Query Language query
`T`	`friends_areFriends(java.util.Collection<java.lang.Long> userIds1, java.util.Collection<java.lang.Long> userIds2)` Retrieves whether pairs of users are friends.
`T`	`friends_areFriends(long userId1, long userId2)` Retrieves whether two users are friends.
`T`	`friends_get()` Retrieves the friends of the currently logged in user.
`T`	`friends_get(java.lang.Long uid)` Retrieves the friends uid.
`T`	`friends_getAppUsers()` Retrieves the friends of the currently logged in user, who are also users of the calling application.
`T`	`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`.
`T`	`friends_getLists()` Retrieves the friend lists of the currently logged in user.
`T`	`friends_getMutualFriends(java.lang.Long targetId)` Returns the Facebook user IDs of the mutual friends between the source user and target user.
`T`	`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.
`java.lang.String`	`getApiKey()`
`java.lang.Boolean`	`getCacheAppUser()` Deprecated.
`java.lang.Long`	`getCacheSessionExpires()`
`java.lang.String`	`getCacheSessionKey()`
`java.lang.Long`	`getCacheUserId()`
`int`	`getConnectTimeout()` Deprecated.
`java.lang.String`	`getRawResponse()` Returns a string representation for the last API response recieved from Facebook, exactly as sent by the API server.
`int`	`getReadTimeout()` Deprecated.
`java.lang.String`	`getResponseFormat()`
`java.lang.String`	`getSecret()`
`java.net.URL`	`getServerUrl()`
`T`	`groups_get(java.lang.Long userId, java.util.Collection<java.lang.Long> groupIds)` Retrieves the groups associated with a user
`T`	`groups_getMembers(java.lang.Number groupId)` Retrieves the membership list of a group
`int`	`intl_uploadNativeStrings(java.util.Map<java.lang.String,java.lang.String> native_strings)` Lets you insert text strings in their native language into the Facebook Translations database so they can be translated.
`boolean`	`isDesktop()` Check to see if the client is running in desktop-app mode
`java.lang.Long`	`links_post(java.lang.Long userId, java.lang.String url, java.lang.String comment)` Posts a link to the specified user's Wall.
`java.lang.Boolean`	`liveMessage_send(java.lang.Long recipient, java.lang.String eventName, org.json.JSONObject message)` Sends a message using the LiveMessage API.
`T`	`notifications_get()` Deprecated.
`java.util.Collection<java.lang.String>`	`notifications_send(java.lang.CharSequence notification)` Deprecated.
`java.util.Collection<java.lang.String>`	`notifications_send(java.util.Collection<java.lang.Long> recipientIds, java.lang.CharSequence notification)` Deprecated.
`java.net.URL`	`notifications_send(java.util.Collection<java.lang.Long> recipientIds, java.lang.CharSequence notification, java.lang.CharSequence email)` Deprecated. notifications.send can no longer be used for sending e-mails, use notifications.sendEmail intead when sending e-mail, or the alternate version of notifications.send if all you want to send is a notification.
`java.util.Collection<java.lang.String>`	`notifications_send(java.util.Collection<java.lang.Long> recipientIds, java.lang.String notification, boolean isAppToUser)` Deprecated.
`java.lang.String`	`notifications_sendEmail(java.util.Collection<java.lang.Long> recipientIds, java.lang.CharSequence subject, java.lang.CharSequence fbml)` Deprecated. provided for legacy support only, please use one of the alternate notifications_sendEmail calls.
`java.util.Collection<java.lang.String>`	`notifications_sendEmail(java.util.Collection<java.lang.Long> recipients, java.lang.CharSequence subject, java.lang.CharSequence email, java.lang.CharSequence fbml)` Send an e-mail to a set of app-users.
`java.lang.String`	`notifications_sendEmailPlain(java.util.Collection<java.lang.Long> recipientIds, java.lang.CharSequence subject, java.lang.CharSequence text)` Deprecated. provided for legacy support only, please use one of the alternate notifications_sendEmail calls.
`java.lang.String`	`notifications_sendEmailStr(java.util.Collection<java.lang.Long> recipientIds, java.lang.CharSequence subject, java.lang.CharSequence fbml, java.lang.CharSequence text)` Deprecated. provided for legacy support only, please use one of the alternate notifications_sendEmail calls.
`java.util.Collection<java.lang.String>`	`notifications_sendEmailToCurrentUser(java.lang.String subject, java.lang.String email, java.lang.String fbml)` Send an e-mail to the currently logged-in user.
`java.util.Collection<java.lang.String>`	`notifications_sendFbmlEmail(java.util.Collection<java.lang.Long> recipients, java.lang.String subject, java.lang.String fbml)` Send an e-mail to a set of app-users.
`java.util.Collection<java.lang.String>`	`notifications_sendFbmlEmailToCurrentUser(java.lang.String subject, java.lang.String fbml)` Send an e-mail to the currently logged-in user.
`java.util.Collection<java.lang.String>`	`notifications_sendTextEmail(java.util.Collection<java.lang.Long> recipients, java.lang.String subject, java.lang.String email)` Send an e-mail to a set of app-users.
`java.util.Collection<java.lang.String>`	`notifications_sendTextEmailToCurrentUser(java.lang.String subject, java.lang.String email)` Send an e-mail to the currently logged-in user.
`T`	`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`.
`T`	`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`.
`T`	`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`.
`T`	`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`.
`boolean`	`pages_isAdmin(java.lang.Long pageId)` Checks whether the logged-in user for this session is an admin of the page with the given `pageId`.
`boolean`	`pages_isAppAdded(java.lang.Long pageId)` Checks whether a page has added the application
`boolean`	`pages_isFan(java.lang.Long pageId)` Checks whether the logged-in user is a fan of the page with the given `pageId`.
`boolean`	`pages_isFan(java.lang.Long pageId, java.lang.Long userId)` Checks whether a user is a fan of the page with the given `pageId`.
`java.lang.Object`	`payments_getOrders(java.lang.String status, long startTime, long endTime)` Returns all orders for the given application
`T`	`permissions_checkAvailableApiAccess(java.lang.String apiKey)` Check to see what permissions have been granted to current app by the specified external application.
`T`	`permissions_checkGrantedApiAccess(java.lang.String apiKey)` Check to see what permissions have been granted to specified external application by the current application.
`boolean`	`permissions_grantApiAccess(java.lang.String apiKey, java.util.Set<FacebookMethod> methods)` Grant permission to an external app to make API calls on behalf of the current application.
`boolean`	`permissions_grantFullApiAccess(java.lang.String apiKey)` Grant permission to an external app to make API calls on behalf of the current application.
`boolean`	`permissions_revokeApiAccess(java.lang.String apiKey)` Revokes the specified application's permission to call API methods on behalf of the current app.
`boolean`	`photos_addTag(java.lang.String photoId, java.lang.CharSequence tagText, java.lang.Double xPct, java.lang.Double yPct)` Adds a tag to a photo.
`boolean`	`photos_addTag(java.lang.String photoId, java.lang.CharSequence tagText, java.lang.Double xPct, java.lang.Double yPct, java.lang.Long userId)` Adds a tag to a photo.
`boolean`	`photos_addTag(java.lang.String photoId, java.lang.Long taggedUserId, java.lang.Double xPct, java.lang.Double yPct)` Adds a tag to a photo.
`boolean`	`photos_addTag(java.lang.String photoId, java.lang.Long taggedUserId, java.lang.Double xPct, java.lang.Double yPct, java.lang.Long userId)` Adds a tag to a photo.
`T`	`photos_addTags(java.lang.String photoId, java.util.Collection<PhotoTag> tags)` Adds several tags to a photo.
`T`	`photos_addTags(java.lang.String photoId, java.util.Collection<PhotoTag> tags, java.lang.Long userId)` Adds several tags to a photo.
`T`	`photos_createAlbum(java.lang.String albumName)` Creates an album.
`T`	`photos_createAlbum(java.lang.String albumName, java.lang.Long userId)` Creates an album.
`T`	`photos_createAlbum(java.lang.String name, java.lang.String description, java.lang.String location)` Creates an album.
`T`	`photos_createAlbum(java.lang.String name, java.lang.String description, java.lang.String location, java.lang.Long userId)` Creates an album.
`T`	`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).
`T`	`photos_get(java.lang.Long subjId)` Used to retrieve photo objects using the search parameters (one or more of the parameters must be provided).
`T`	`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).
`T`	`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).
`T`	`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).
`T`	`photos_getAlbums(java.util.Collection<java.lang.String> albumIds)` Retrieves album metadata for a list of album IDs.
`T`	`photos_getAlbums(java.lang.Long userId)` Retrieves album metadata for albums owned by a user.
`T`	`photos_getAlbums(java.lang.Long userId, java.util.Collection<java.lang.String> albumIds)` Retrieves album metadata.
`T`	`photos_getByAlbum(java.lang.String albumId)` Used to retrieve photo objects using the search parameters (one or more of the parameters must be provided).
`T`	`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).
`T`	`photos_getTags(java.util.Collection<java.lang.String> photoIds)` Retrieves the tags for the given set of photos.
`T`	`photos_upload(java.io.File photo)` Uploads a photo to Facebook.
`T`	`photos_upload(java.io.File photo, java.lang.String caption, java.lang.String albumId)` Uploads a photo to Facebook.
`T`	`photos_upload(java.lang.Long userId, java.io.File photo)` Uploads a photo to Facebook.
`T`	`photos_upload(java.lang.Long userId, java.io.File photo, java.lang.String caption, java.lang.String albumId)` Uploads a photo to Facebook.
`T`	`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.
`T`	`photos_uploadToAlbum(java.io.File photo, java.lang.String albumId)` Uploads a photo to Facebook.
`T`	`photos_uploadToAlbum(java.lang.Long userId, java.io.File photo, java.lang.String albumId)` Uploads a photo to Facebook.
`T`	`photos_uploadWithCaption(java.io.File photo, java.lang.String caption)` Uploads a photo to Facebook.
`T`	`photos_uploadWithCaption(java.lang.Long userId, java.io.File photo, java.lang.String caption)` Uploads a photo to Facebook.
`T`	`profile_getFBML()` Deprecated.
`T`	`profile_getFBML(int type)` Deprecated.
`T`	`profile_getFBML(int type, java.lang.Long userId)` Deprecated.
`T`	`profile_getFBML(java.lang.Long userId)` Deprecated.
`T`	`profile_getInfo(java.lang.Long userId)` Deprecated.
`T`	`profile_getInfoOptions(java.lang.String field)` Deprecated.
`boolean`	`profile_setFBML(java.lang.CharSequence profileFbmlMarkup, java.lang.CharSequence profileActionFbmlMarkup)` Deprecated. trying to reduce superfluous methods, use `profile_setFBML(Long, String, String, String, String)`
`boolean`	`profile_setFBML(java.lang.CharSequence profileFbmlMarkup, java.lang.CharSequence profileActionFbmlMarkup, java.lang.CharSequence mobileFbmlMarkup)` Deprecated. trying to reduce superfluous methods, use `profile_setFBML(Long, String, String, String, String)`
`boolean`	`profile_setFBML(java.lang.CharSequence profileFbmlMarkup, java.lang.CharSequence profileActionFbmlMarkup, java.lang.CharSequence mobileFbmlMarkup, java.lang.Long profileId)` Deprecated. trying to reduce superfluous methods, use `profile_setFBML(Long, String, String, String, String)`
`boolean`	`profile_setFBML(java.lang.CharSequence profileFbmlMarkup, java.lang.CharSequence profileActionFbmlMarkup, java.lang.Long profileId)` Deprecated. trying to reduce superfluous methods, use `profile_setFBML(Long, String, String, String, String)`
`boolean`	`profile_setFBML(java.lang.Long userId, java.lang.String profileFbml, java.lang.String actionFbml, java.lang.String mobileFbml)` Deprecated. trying to reduce superfluous methods, use `profile_setFBML(Long, String, String, String, String)`
`boolean`	`profile_setFBML(java.lang.Long userId, java.lang.String profileFbml, java.lang.String actionFbml, java.lang.String mobileFbml, java.lang.String profileMain)` Deprecated.
`void`	`profile_setInfo(java.lang.Long userId, java.lang.String title, boolean textOnly, java.util.List<ProfileInfoField> fields)` Deprecated.
`void`	`profile_setInfoOptions(ProfileInfoField field)` Deprecated.
`boolean`	`profile_setMobileFBML(java.lang.CharSequence fbmlMarkup)` Deprecated. trying to reduce superfluous methods, use `profile_setFBML(Long, String, String, String, String)`
`boolean`	`profile_setMobileFBML(java.lang.CharSequence fbmlMarkup, java.lang.Long profileId)` Deprecated. trying to reduce superfluous methods, use `profile_setFBML(Long, String, String, String, String)`
`boolean`	`profile_setProfileActionFBML(java.lang.CharSequence fbmlMarkup)` Deprecated. trying to reduce superfluous methods, use `profile_setFBML(Long, String, String, String, String)`
`boolean`	`profile_setProfileActionFBML(java.lang.CharSequence fbmlMarkup, java.lang.Long profileId)` Deprecated. trying to reduce superfluous methods, use `profile_setFBML(Long, String, String, String, String)`
`boolean`	`profile_setProfileFBML(java.lang.CharSequence fbmlMarkup)` Deprecated. trying to reduce superfluous methods, use `profile_setFBML(Long, String, String, String, String)`
`boolean`	`profile_setProfileFBML(java.lang.CharSequence fbmlMarkup, java.lang.Long profileId)` Deprecated. trying to reduce superfluous methods, use `profile_setFBML(Long, String, String, String, String)`
`void`	`setCacheAppUser(java.lang.Boolean appUser)` Deprecated.
`void`	`setCacheSession(java.lang.String cacheSessionKey, java.lang.Long cacheUserId, java.lang.Long cacheSessionExpires)`
`void`	`setConnectTimeout(int connectTimeout)` Deprecated.
`void`	`setReadTimeout(int readTimeout)` Deprecated.
`void`	`setServerUrl(java.lang.String newUrl)`
`void`	`setServerUrl(java.net.URL newUrl)` Override the default Facebook API server used for making requests.
`boolean`	`sms_canSend()` Check to see if the application is permitted to send SMS messages to the current application user.
`boolean`	`sms_canSend(java.lang.Long userId)` Check to see if the application is permitted to send SMS messages to the specified user.
`java.lang.Integer`	`sms_send(java.lang.Long userId, java.lang.String message, java.lang.Integer smsSessionId, boolean makeNewSession)` Send an SMS message to the specified user.
`java.lang.Integer`	`sms_send(java.lang.String message, java.lang.Integer smsSessionId, boolean makeNewSession)` Send an SMS message to the current application user.
`void`	`sms_sendMessage(java.lang.Long userId, java.lang.CharSequence message)` Sends a message via SMS to the user identified by `userId`.
`int`	`sms_sendMessageWithSession(java.lang.Long userId, java.lang.CharSequence message)` Sends a message via SMS to the user identified by `userId`, with the expectation that the user will reply.
`java.lang.String`	`stream_addComment(java.lang.String postId, java.lang.String comment, java.lang.Long userId)`
`boolean`	`stream_addLike(java.lang.String postId, java.lang.Long userId)`
`T`	`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)`
`T`	`stream_getComments(java.lang.String postId)`
`T`	`stream_getFilters(java.lang.Long userId)`
`java.lang.String`	`stream_publish(java.lang.String message, Attachment attachment, java.util.Collection<BundleActionLink> actionLinks, java.lang.Long targetId, java.lang.Long userId)`
`boolean`	`stream_remove(java.lang.String postId, java.lang.Long userId)`
`boolean`	`stream_removeComment(java.lang.String commentId, java.lang.Long userId)`
`boolean`	`stream_removeLike(java.lang.String postId, java.lang.Long userId)`
`boolean`	`users_clearStatus()` Clears the logged-in user's Facebook status.
`T`	`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.
`T`	`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.
`long`	`users_getLoggedInUser()` Retrieves the user ID of the user logged in to this API session
`T`	`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.
`T`	`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.
`boolean`	`users_hasAppPermission(Permission perm)`
`boolean`	`users_hasAppPermission(Permission perm, java.lang.Long userId)` Checks whether the user has opted in to an extended application permission.
`boolean`	`users_isAppUser()`
`boolean`	`users_isAppUser(java.lang.Long userId)` Returns whether the user (either the session user or user specified by uid) has authorized the calling application.
`boolean`	`users_setStatus(java.lang.String status)` Sets the logged-in user's Facebook status.
`boolean`	`users_setStatus(java.lang.String newStatus, boolean clear)` Set the user's profile status message.
`boolean`	`users_setStatus(java.lang.String newStatus, boolean clear, boolean statusIncludesVerb)` Set the user's profile status message.
`boolean`	`users_setStatus(java.lang.String newStatus, boolean clear, boolean statusIncludesVerb, java.lang.Long userId)` Set the user's profile status message.
`boolean`	`users_setStatus(java.lang.String newStatus, boolean clear, java.lang.Long userId)` Set the user's profile status message.
`boolean`	`users_setStatus(java.lang.String status, java.lang.Long userId)` Sets the spedified user's Facebook status.

Field Detail

TARGET_API_VERSION

static final java.lang.String TARGET_API_VERSION

See Also:: Constant Field Values

ERROR_TAG

static final java.lang.String ERROR_TAG

See Also:: Constant Field Values

Method Detail

getServerUrl

java.net.URL getServerUrl()

setServerUrl

void setServerUrl(java.net.URL newUrl)

Override the default Facebook API server used for making requests. Can be used to tell the client to run against the

Parameters:: newUrl - the new URL to use, for example: "http://api.facebook.com/restserver.php"
Throws:: java.net.MalformedURLException

setServerUrl

void setServerUrl(java.lang.String newUrl)

getConnectTimeout

@Deprecated
int getConnectTimeout()

Deprecated.

setConnectTimeout

@Deprecated
void setConnectTimeout(int connectTimeout)

Deprecated.

getReadTimeout

@Deprecated
int getReadTimeout()

Deprecated.

setReadTimeout

@Deprecated
void setReadTimeout(int readTimeout)

Deprecated.

getResponseFormat

java.lang.String getResponseFormat()

getApiKey

java.lang.String getApiKey()

getSecret

java.lang.String getSecret()

isDesktop

boolean isDesktop()

Check to see if the client is running in desktop-app mode

Returns:: true if the app is running in desktop mode. false otherwise

getCacheAppUser

@Deprecated
java.lang.Boolean getCacheAppUser()

Deprecated.

setCacheAppUser

@Deprecated
void setCacheAppUser(java.lang.Boolean appUser)

Deprecated.

setCacheSession

void setCacheSession(java.lang.String cacheSessionKey,
                     java.lang.Long cacheUserId,
                     java.lang.Long cacheSessionExpires)

profile_setFBML

@Deprecated
boolean profile_setFBML(java.lang.Long userId,
                                   java.lang.String profileFbml,
                                   java.lang.String actionFbml,
                                   java.lang.String mobileFbml,
                                   java.lang.String profileMain)
                        throws FacebookException

Deprecated.

Sets the FBML for a user's profile, including the content for both the profile box and the profile actions.

Parameters:: userId - The user ID for the user whose profile you are updating, or the page ID in case of a Page. If this parameter is not specified, then it defaults to the session user. Note: This parameter applies only to Web applications and is required by them only if the session_key is not specified. Facebook returns an error if this parameter is passed by a desktop application.; profileFbml - The FBML intended for the application profile box that appears on the Boxes tab on the user's profile.; actionFbml - The FBML intended for the user's profile actions. A profile action is the link under the user's profile picture that allows a user to take an action with your application. Note: This attribute is being deprecated when the new profile design launches in July 2008, as there are no third party profile action links on the new profile.; mobileFbml - The FBML intended for mobile devices.; profileMain - The FBML intended for the narrow profile box on the Wall and Info tabs of the user's profile. Note: This attribute applies only to the new profile design that launched July 2008.
Returns:: a boolean indicating whether the FBML was successfully set
Throws:: FacebookException
See Also:: http://wiki.developers.facebook.com/index.php/Profile.setFBML