IFacebookRestClient (Facebook Java Library 2.0.2 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, FacebookJsonRestClient, FacebookRestClient, FacebookXmlRestClient

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`	`FB_SERVER`
`static java.lang.String`	`HTTPS_SERVER_ADDR`
`static java.lang.String`	`SERVER_ADDR`
`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(java.lang.String allocationType)` 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.EnumSet<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.
`long`	`auth_getUserId(java.lang.String authToken)` Deprecated.
`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.
`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.
`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.
`java.lang.String`	`data_getUserPreference(java.lang.Integer prefId)` Lookup a single preference value for the current user.
`java.util.Map<java.lang.Integer,java.lang.String>`	`data_getUserPreferences()` Get a map containing all preference values set for the current user.
`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_setUserPreference(java.lang.Integer 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`	`endPermissionsMode()` Terminates permissions mode.
`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_getMembers(java.lang.Number eventId)` Retrieves the membership list of an event
`java.util.List<? extends java.lang.Object>`	`executeBatch(boolean serial)` Executes a batch of queries.
`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.
`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)` Deactivates the specified template bundle.
`T`	`feed_getRegisteredTemplateBundleByID(java.lang.Long id)` Retrieve a template bundle by id.
`T`	`feed_getRegisteredTemplateBundles()` Get a list of all registered template bundles for your application.
`boolean`	`feed_publishTemplatizedAction(java.lang.CharSequence titleTemplate)` Publishes a Mini-Feed story describing an action taken by the logged-in user, and publishes aggregating News Feed stories to their friends.
`boolean`	`feed_publishTemplatizedAction(java.lang.CharSequence titleTemplate, java.lang.Long pageActorId)` Publishes a Mini-Feed story describing an action taken by the logged-in user (or, if `pageActorId` is provided, page), and publishes aggregating News Feed stories to the user's friends/page's fans.
`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)` Publishes a Mini-Feed story describing an action taken by the logged-in user (or, if `pageActorId` is provided, page), and publishes aggregating News Feed stories to the user's friends/page's fans.
`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)` Publishes a Mini-Feed story describing an action taken by a user, and publishes aggregating News Feed stories to the friends of that user.
`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)` Publishes a templatized action for the current user.
`boolean`	`feed_PublishTemplatizedAction(TemplatizedAction action)` Publishes a templatized action for the current user.
`java.lang.Boolean`	`feed_publishUserAction(java.lang.Long bundleId)` Publishes a user action to the feed.
`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)` Publishes a user action to the feed.
`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)` Publishes a user action to the feed.
`java.lang.Long`	`feed_registerTemplateBundle(java.util.Collection<java.lang.String> templates)` Registers a feed template.
`java.lang.Long`	`feed_registerTemplateBundle(java.util.Collection<java.lang.String> templates, java.util.Collection<BundleStoryTemplate> shortTemplates, BundleStoryTemplate longTemplate)` Registers a feed template.
`java.lang.Long`	`feed_registerTemplateBundle(java.lang.String template)` Registers a feed template.
`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 friendListId)` Retrieves the friends of the currently logged in user that are members of the friends list with ID `friendListId`.
`T`	`friends_getAppUsers()` Retrieves the friends of the currently logged in user, who are also users of the calling application.
`T`	`friends_getLists()` Retrieves the friend lists of the currently logged in user.
`java.lang.Boolean`	`getCacheAppAdded()`
`T`	`getCacheFriendsList()`
`java.lang.Long`	`getCacheSessionExpires()`
`java.lang.String`	`getCacheSessionKey()`
`java.lang.String`	`getCacheSessionSecret()`
`java.lang.Long`	`getCacheUserId()`
`java.net.URL`	`getDefaultServerUrl()`
`javax.xml.bind.JAXBContext`	`getJaxbContext()` Get the JAXB context that is being used by the client.
`java.lang.String`	`getRawResponse()` Returns a string representation for the last API response recieved from Facebook, exactly as sent by the API server.
`java.lang.Object`	`getResponsePOJO()` Returns a JAXB object of the type that corresponds to the last API call made on the client.
`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
`boolean`	`isDesktop()` Check to see if the client is running in desktop-app mode
`java.lang.Boolean`	`liveMessage_send(java.lang.Long recipient, java.lang.String eventName, org.json.JSONObject message)` Sends a message using the LiveMessage API.
`java.lang.Long`	`marketplace_createListing(boolean showOnProfile, MarketListing listing)` Create a new marketplace listing.
`java.lang.Long`	`marketplace_createListing(boolean showOnProfile, MarketListing listing, java.lang.Long userId)` Create a new marketplace listing.
`java.lang.Long`	`marketplace_createListing(java.lang.Boolean showOnProfile, MarketplaceListing attrs)` Deprecated. provided for legacy support only. Please use the version that takes a MarketListing instead.
`java.lang.Long`	`marketplace_createListing(java.lang.Long listingId, boolean showOnProfile, MarketListing listing)` Create a new marketplace listing, or modify an existing one.
`java.lang.Long`	`marketplace_createListing(java.lang.Long listingId, boolean showOnProfile, MarketListing listing, java.lang.Long userId)` Create a new marketplace listing, or modify an existing one.
`java.lang.Long`	`marketplace_createListing(java.lang.Long listingId, boolean showOnProfile, java.lang.String attributes)` Create a new marketplace listing, or modify an existing one.
`java.lang.Long`	`marketplace_createListing(java.lang.Long listingId, boolean showOnProfile, java.lang.String attributes, java.lang.Long userId)` Create a new marketplace listing, or modify an existing one.
`java.lang.Long`	`marketplace_editListing(java.lang.Long listingId, java.lang.Boolean showOnProfile, MarketListing attrs)` Modify a marketplace listing
`java.lang.Long`	`marketplace_editListing(java.lang.Long listingId, java.lang.Boolean showOnProfile, MarketplaceListing attrs)` Deprecated. provided for legacy support only. Please use the version that takes a MarketListing instead.
`java.util.List<java.lang.String>`	`marketplace_getCategories()` Get the categories available in marketplace.
`T`	`marketplace_getCategoriesObject()` Deprecated. use the version that returns a List instead.
`T`	`marketplace_getListings(java.util.Collection<java.lang.Long> listingIds, java.util.Collection<java.lang.Long> userIds)` Fetch marketplace listings, filtered by listing IDs and/or the posting users' IDs.
`java.util.List<Listing>`	`marketplace_getListings(java.util.List<java.lang.Long> listingIds, java.util.List<java.lang.Long> uids)` Retrieve listings from the marketplace.
`java.util.List<java.lang.String>`	`marketplace_getSubCategories()` Return a list of all valid Marketplace subcategories.
`T`	`marketplace_getSubCategories(java.lang.CharSequence category)` Get the subcategories available for a category.
`boolean`	`marketplace_removeListing(java.lang.Long listingId)` Remove a marketplace listing.
`boolean`	`marketplace_removeListing(java.lang.Long listingId, java.lang.CharSequence status)` Deprecated. provided for legacy support only. Please use the version that takes a MarketListingStatus instead.
`boolean`	`marketplace_removeListing(java.lang.Long listingId, java.lang.Long userId)` Remove a marketplace listing.
`boolean`	`marketplace_removeListing(java.lang.Long listingId, MarketListingStatus status)` Remove a listing from the marketplace by id.
`boolean`	`marketplace_removeListing(java.lang.Long listingId, MarketListingStatus status, java.lang.Long userId)` Remove a listing from the marketplace by id.
`T`	`marketplace_search(java.lang.CharSequence category, java.lang.CharSequence subCategory, java.lang.CharSequence query)` Deprecated. provided for legacy support only. Please use the alternate version instead.
`java.util.List<Listing>`	`marketplace_search(MarketListingCategory category, MarketListingSubcategory subcategory, java.lang.String searchTerm)` Search the marketplace listings by category, subcategory, and keyword.
`T`	`notifications_get()` Retrieves the outstanding notifications for the session user.
`void`	`notifications_send(java.lang.CharSequence notification)` Send a notification message to the logged-in user.
`void`	`notifications_send(java.util.Collection<java.lang.Long> recipientIds, java.lang.CharSequence notification)` Send a notification message to the specified users.
`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.
`void`	`notifications_send(java.util.Collection<java.lang.Long> recipientIds, java.lang.String notification, boolean isAppToUser)` Sends a notification.
`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.
`T`	`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.
`T`	`notifications_sendEmailToCurrentUser(java.lang.String subject, java.lang.String email, java.lang.String fbml)` Send an e-mail to the currently logged-in user.
`T`	`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.
`T`	`notifications_sendFbmlEmailToCurrentUser(java.lang.String subject, java.lang.String fbml)` Send an e-mail to the currently logged-in user.
`T`	`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.
`T`	`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.EnumSet<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.EnumSet<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`.
`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.Long photoId, java.lang.CharSequence tagText, java.lang.Double xPct, java.lang.Double yPct)` Adds a tag to a photo.
`boolean`	`photos_addTag(java.lang.Long 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.Long photoId, java.lang.Long taggedUserId, java.lang.Double xPct, java.lang.Double yPct)` Adds a tag to a photo.
`boolean`	`photos_addTag(java.lang.Long 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.Long photoId, java.util.Collection<PhotoTag> tags)` Adds several tags to a photo.
`T`	`photos_addTags(java.lang.Long 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.Long> 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.Long> 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.Long 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.Long albumId, java.util.Collection<java.lang.Long> 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.Long> 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.Long> albumIds)` Retrieves album metadata.
`T`	`photos_getByAlbum(java.lang.Long albumId)` Used to retrieve photo objects using the search parameters (one or more of the parameters must be provided).
`T`	`photos_getByAlbum(java.lang.Long albumId, java.util.Collection<java.lang.Long> 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.Long> 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.Long albumId)` Uploads a photo to Facebook.
`T`	`photos_upload(java.io.File photo, java.lang.String caption)` Uploads a photo to Facebook.
`T`	`photos_upload(java.io.File photo, java.lang.String caption, java.lang.Long 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.Long albumId)` Uploads a photo to Facebook.
`T`	`photos_upload(java.lang.Long userId, java.io.File photo, java.lang.String caption)` Uploads a photo to Facebook.
`T`	`photos_upload(java.lang.Long userId, java.io.File photo, java.lang.String caption, java.lang.Long albumId)` Uploads a photo to Facebook.
`T`	`profile_getFBML()` Gets the FBML for the current user's profile box.
`T`	`profile_getFBML(int type)` Gets the FBML for the current user's profile boxes.
`T`	`profile_getFBML(int type, java.lang.Long userId)` Gets the FBML for the user's profile boxes.
`T`	`profile_getFBML(java.lang.Long userId)` Gets the FBML for the user's profile box.
`T`	`profile_getInfo(java.lang.Long userId)` Get the specified user's application-info section.
`T`	`profile_getInfoOptions(java.lang.String field)` Get the options associated with the specified field for an application info section.
`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)` Sets the FBML for a user's profile, including the content for both the profile box and the profile actions.
`void`	`profile_setInfo(java.lang.Long userId, java.lang.String title, boolean textOnly, java.util.List<ProfileInfoField> fields)` Configures an application info section that the specified user can install on the Info tab of her profile.
`void`	`profile_setInfoOptions(ProfileInfoField field)` Specifies the objects for a field for an application info section.
`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`	`setCacheAppAdded(java.lang.Boolean appAdded)`
`void`	`setCacheFriendsList(java.util.List<java.lang.Long> friendIds)`
`void`	`setCacheSession(java.lang.String cacheSessionKey, java.lang.Long cacheUserId, java.lang.Long cacheSessionExpires)`
`void`	`setDefaultServerUrl(java.net.URL url)`
`void`	`setIsDesktop(boolean isDesktop)` Set the client to run in desktop-app mode.
`void`	`setJaxbContext(javax.xml.bind.JAXBContext context)` Set the JAXB context that the client will use.
`void`	`setServerUrl(java.lang.String 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.
`boolean`	`users_clearStatus()` Clears the logged-in user's Facebook status.
`T`	`users_getInfo(java.util.Collection<java.lang.Long> userIds, java.util.Collection<ProfileField> fields)` Retrieves the requested info fields for the requested set of users.
`T`	`users_getInfo(java.util.Collection<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_isAppAdded()` Deprecated.
`boolean`	`users_isAppAdded(java.lang.Long userId)` Deprecated.
`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

FB_SERVER

static final java.lang.String FB_SERVER

See Also:: Constant Field Values

SERVER_ADDR

static final java.lang.String SERVER_ADDR

See Also:: Constant Field Values

HTTPS_SERVER_ADDR

static final java.lang.String HTTPS_SERVER_ADDR

See Also:: Constant Field Values

Method Detail

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

setIsDesktop

void setIsDesktop(boolean isDesktop)

Set the client to run in desktop-app mode.

Parameters:: isDesktop - set to true to enable desktop mode set to false to disable desktop mode

getCacheFriendsList

T getCacheFriendsList()

setCacheFriendsList

void setCacheFriendsList(java.util.List<java.lang.Long> friendIds)

getCacheAppAdded

java.lang.Boolean getCacheAppAdded()

setCacheAppAdded

void setCacheAppAdded(java.lang.Boolean appAdded)

setCacheSession

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

profile_setFBML

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,
                               java.io.IOException

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; java.io.IOException
See Also:: http://wiki.developers.facebook.com/index.php/Profile.setFBML