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
Class SpecificReturnTypeAdapter<T>

java.lang.Object
  extended by com.google.code.facebookapi.BaseAdapter
      extended by com.google.code.facebookapi.SpecificReturnTypeAdapter<T>
All Implemented Interfaces:
IFacebookRestClient<T>
Direct Known Subclasses:
FacebookJaxbRestClientBase, FacebookJsonRestClientBase, FacebookXmlRestClientBase
public abstract class SpecificReturnTypeAdapter<T>
extends BaseAdapter
implements IFacebookRestClient<T>

Eventually want this to have no methods in it whatsoever. This base adapter covers the cases where we want to do a simple proxy to the ExtensibleClient because the return type on the ExtensibleClient is not Object or void.

Field Summary
 
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
protected SpecificReturnTypeAdapter(java.lang.String responseFormat, ExtensibleClient client)
           
 
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. 
 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.
 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.
 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.
 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.
 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> newsItemIds)
          Clears specific global news items from application.
 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
 long data_getAssociatedObjectCount(java.lang.String associationName, long objectId)
          Returns count of object ids that are associated with specified object.
 java.lang.String data_getUserPreference(int prefId)
          Lookup a single preference value 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.
 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.
 boolean events_rsvp(java.lang.Long eid, java.lang.String rsvp_status)
          Sets a user's RSVP status for an event.
 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)
          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. 
 boolean feed_publishTemplatizedAction(java.lang.Long actorId, java.lang.CharSequence titleTemplate)
          Deprecated. 
 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. 
 java.lang.Boolean getCacheAppUser()
          Deprecated. 
 java.lang.Long getCacheSessionExpires()
           
 java.lang.String getCacheSessionKey()
           
 java.lang.Long getCacheUserId()
           
 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.
 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. 
 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. 
 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. 
 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. 
 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.
 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.
 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 pct, java.lang.Double pct2)
          Adds a tag to a photo.
 boolean photos_addTag(java.lang.String photoId, java.lang.CharSequence tagText, java.lang.Double pct, java.lang.Double pct2, java.lang.Long userId)
          Adds a tag to a photo.
 boolean photos_addTag(java.lang.String photoId, java.lang.Long taggedUserId, java.lang.Double pct, java.lang.Double pct2)
          Adds a tag to a photo.
 boolean photos_addTag(java.lang.String photoId, java.lang.Long taggedUserId, java.lang.Double pct, java.lang.Double pct2, java.lang.Long userId)
          Adds a tag to a photo.
 boolean profile_setFBML(java.lang.CharSequence profileFbmlMarkup, java.lang.CharSequence profileActionFbmlMarkup)
          Deprecated. 
 boolean profile_setFBML(java.lang.CharSequence profileFbmlMarkup, java.lang.CharSequence profileActionFbmlMarkup, java.lang.CharSequence mobileFbmlMarkup)
          Deprecated. 
 boolean profile_setFBML(java.lang.CharSequence profileFbmlMarkup, java.lang.CharSequence profileActionFbmlMarkup, java.lang.CharSequence mobileFbmlMarkup, java.lang.Long profileId)
          Deprecated. 
 boolean profile_setFBML(java.lang.CharSequence profileFbmlMarkup, java.lang.CharSequence profileActionFbmlMarkup, java.lang.Long profileId)
          Deprecated. 
 boolean profile_setFBML(java.lang.Long userId, java.lang.String profileFbml, java.lang.String actionFbml, java.lang.String mobileFbml)
          Deprecated. 
 boolean profile_setFBML(java.lang.Long userId, java.lang.String profileFbml, java.lang.String actionFbml, java.lang.String mobileFbml, java.lang.String profileMain)
          Deprecated. 
 boolean profile_setMobileFBML(java.lang.CharSequence fbmlMarkup)
          Deprecated. 
 boolean profile_setMobileFBML(java.lang.CharSequence fbmlMarkup, java.lang.Long profileId)
          Deprecated. 
 boolean profile_setProfileActionFBML(java.lang.CharSequence fbmlMarkup)
          Deprecated. 
 boolean profile_setProfileActionFBML(java.lang.CharSequence fbmlMarkup, java.lang.Long profileId)
          Deprecated. 
 boolean profile_setProfileFBML(java.lang.CharSequence fbmlMarkup)
          Deprecated. 
 boolean profile_setProfileFBML(java.lang.CharSequence fbmlMarkup, java.lang.Long profileId)
          Deprecated. 
 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.
 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)
           
 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.
 long users_getLoggedInUser()
          Retrieves the user ID of the user logged in to this API session
 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.
 
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
admin_getDailyMetrics, admin_getDailyMetrics, admin_getMetrics, admin_getMetrics, application_getPublicInfo, application_getPublicInfoByApiKey, application_getPublicInfoByCanvasName, application_getPublicInfoById, batch_run, beginBatch, beginPermissionsMode, connect_registerUsers, connect_unregisterUsers, dashboard_multiAddNews, dashboard_multiAddNews, dashboard_multiClearNews, dashboard_multiClearNews, data_createObjectType, data_defineAssociation, data_defineObjectProperty, data_deleteObject, data_deleteObjects, data_dropObjectType, data_getAssociationDefinition, data_getAssociationDefinitions, data_getCookies, data_getCookies, data_getCookies, data_getCookies, data_getObject, data_getObjectProperty, data_getObjects, data_getObjectType, data_getObjectTypes, data_getUserPreferences, 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, events_get, events_get, events_getMembers, executeBatch, fbml_deleteCustomTags, fbml_getCustomTags, fbml_registerCustomTags, feed_getRegisteredTemplateBundleByID, feed_getRegisteredTemplateBundles, fql_query, friends_areFriends, friends_areFriends, friends_get, friends_get, friends_getAppUsers, friends_getList, friends_getLists, friends_getMutualFriends, friends_getMutualFriends, getApiKey, getConnectTimeout, getRawResponse, getReadTimeout, getResponseFormat, getSecret, getServerUrl, groups_get, groups_getMembers, notifications_get, pages_getInfo, pages_getInfo, pages_getInfo, pages_getInfo, payments_getOrders, permissions_checkAvailableApiAccess, permissions_checkGrantedApiAccess, photos_addTags, photos_addTags, photos_createAlbum, photos_createAlbum, photos_createAlbum, photos_createAlbum, photos_get, photos_get, photos_get, photos_get, photos_get, photos_getAlbums, photos_getAlbums, photos_getAlbums, photos_getByAlbum, photos_getByAlbum, photos_getTags, photos_upload, photos_upload, photos_upload, photos_upload, photos_upload, photos_uploadToAlbum, photos_uploadToAlbum, photos_uploadWithCaption, photos_uploadWithCaption, profile_getFBML, profile_getFBML, profile_getFBML, profile_getFBML, profile_getInfo, profile_getInfoOptions, profile_setInfo, profile_setInfoOptions, setCacheAppUser, setCacheSession, setConnectTimeout, setReadTimeout, setServerUrl, setServerUrl, sms_sendMessage, stream_get, stream_getComments, stream_getFilters, users_getInfo, users_getInfo, users_getStandardInfo, users_getStandardInfo
 

Constructor Detail

SpecificReturnTypeAdapter

protected SpecificReturnTypeAdapter(java.lang.String responseFormat,
                                    ExtensibleClient client)
Method Detail

admin_getAllocation

public int admin_getAllocation(java.lang.String allocationType)
                        throws FacebookException
Description copied from interface: IFacebookRestClient
Get your application's current allocation of the specified type of request (i.e. the number of requests that it is currently allowed to send per user per day).

Specified by:
admin_getAllocation in interface IFacebookRestClient<T>
Parameters:
allocationType - the type of request to check the allocation for. Currently: "notifications_per_day" and "requests_per_day", "emails_per_day", "email_disable_message_location"
Returns:
the number of the specified type of requests that the application is permitted to send per user per day.
Throws:
FacebookException
See Also:
http://wiki.developers.facebook.com/index.php/Admin.getAllocation

admin_getAllocation

public int admin_getAllocation(AllocationType allocationType)
                        throws FacebookException
Description copied from interface: IFacebookRestClient
Get your application's current allocation of the specified type of request (i.e. the number of requests that it is currently allowed to send per user per day).

Specified by:
admin_getAllocation in interface IFacebookRestClient<T>
Parameters:
allocationType - the type of request to check the allocation for. Currently: "notifications_per_day" and "requests_per_day", "emails_per_day", "email_disable_message_location"
Returns:
the number of the specified type of requests that the application is permitted to send per user per day.
Throws:
FacebookException
See Also:
http://wiki.developers.facebook.com/index.php/Admin.getAllocation

admin_getAllocation

public int admin_getAllocation(java.lang.String allocationType,
                               java.lang.Long userId)
                        throws FacebookException
Description copied from interface: IFacebookRestClient
Get your application's current allocation of the specified type of request (i.e. the number of requests that it is currently allowed to send per user per day).

Specified by:
admin_getAllocation in interface IFacebookRestClient<T>
Parameters:
allocationType - the type of request to check the allocation for. Currently: "notifications_per_day" and "requests_per_day", "emails_per_day", "email_disable_message_location"
Returns:
the number of the specified type of requests that the application is permitted to send per user per day.
Throws:
FacebookException
See Also:
http://wiki.developers.facebook.com/index.php/Admin.getAllocation

admin_getAllocation

public int admin_getAllocation(AllocationType allocationType,
                               java.lang.Long userId)
                        throws FacebookException
Description copied from interface: IFacebookRestClient
Get your application's current allocation of the specified type of request (i.e. the number of requests that it is currently allowed to send per user per day).

Specified by:
admin_getAllocation in interface IFacebookRestClient<T>
Parameters:
allocationType - the type of request to check the allocation for. Currently: "notifications_per_day" and "requests_per_day", "emails_per_day", "email_disable_message_location"
Returns:
the number of the specified type of requests that the application is permitted to send per user per day.
Throws:
FacebookException
See Also:
http://wiki.developers.facebook.com/index.php/Admin.getAllocation

admin_getAppPropertiesAsString

public java.lang.String admin_getAppPropertiesAsString(java.util.Collection<ApplicationProperty> properties)
                                                throws FacebookException
Description copied from interface: IFacebookRestClient
Retrieve application properties. The properties are used by Facebook to describe the configuration of your application. This method cannot be called by desktop apps.

Specified by:
admin_getAppPropertiesAsString in interface IFacebookRestClient<T>
Parameters:
properties - a collection indicating the properties you are interested in retrieving.
Returns:
a JSON-encoded string containing the properties. It is your responsibility to parse the string. Details can be found at http://wiki.developers.facebook.com/index.php/Admin.getAppProperties
Throws:
FacebookException

admin_getAppProperties

@Deprecated
public org.json.JSONObject admin_getAppProperties(java.util.Collection<ApplicationProperty> properties)
                                           throws FacebookException
Deprecated. 

Description copied from interface: IFacebookRestClient
Retrieve application properties. The properties are used by Facebook to describe the configuration of your application. This method cannot be called by desktop apps.

Specified by:
admin_getAppProperties in interface IFacebookRestClient<T>
Parameters:
properties - a collection indicating the properties you are interested in retrieving.
Returns:
a JSONObject that maps ApplicationProperty names to their corresponding values.
Throws:
FacebookException

admin_getAppPropertiesAsSet

public ApplicationPropertySet admin_getAppPropertiesAsSet(java.util.Collection<ApplicationProperty> properties)
                                                   throws FacebookException
Description copied from interface: IFacebookRestClient
Gets property values previously set for an application on either the Facebook Developer application or the with the admin.setAppProperties call. A session is not required to use this method. This method cannot be called by desktop apps.

Specified by:
admin_getAppPropertiesAsSet in interface IFacebookRestClient<T>
Parameters:
properties - an enumeration of the properties to get
Returns:
an ApplicationPropertySet
Throws:
FacebookException
See Also:
ApplicationProperty, http://wiki.developers.facebook.com/index.php/Admin.getAppProperties

admin_getAppPropertiesMap

public java.util.Map<ApplicationProperty,java.lang.String> admin_getAppPropertiesMap(java.util.Collection<ApplicationProperty> properties)
                                                                              throws FacebookException
Description copied from interface: IFacebookRestClient
Retrieve application properties. The properties are used by Facebook to describe the configuration of your application. This method cannot be called by desktop apps.

Specified by:
admin_getAppPropertiesMap in interface IFacebookRestClient<T>
Parameters:
properties - a collection indicating the properties you are interested in retrieving.
Returns:
a mapping of ApplicationProperty's to the corresponding values that are set for those properties. Properties are represented as strings, so properties that are of boolean type will have a value of "true" when true, and "false" when false. The properties returned will never be null, an unset property is represented by an empty string.
Throws:
FacebookException

admin_getNotificationAllocation

@Deprecated
public int admin_getNotificationAllocation()
                                    throws FacebookException
Deprecated. 

Description copied from interface: IFacebookRestClient
Get your application's current allocation for notifications (i.e. the total number of notifications that it is allowed to send per user, per day).

Specified by:
admin_getNotificationAllocation in interface IFacebookRestClient<T>
Returns:
the number of notifications that the application is permitted to send per user per day.
Throws:
FacebookException
See Also:
http://wiki.developers.facebook.com/index.php/Admin.getAllocation

admin_getRequestAllocation

@Deprecated
public int admin_getRequestAllocation()
                               throws FacebookException
Deprecated. 

Description copied from interface: IFacebookRestClient
Get your application's current allocation for invites/requests (i.e. the total number of invites/requests that it is allowed to send per user, per day).

Specified by:
admin_getRequestAllocation in interface IFacebookRestClient<T>
Returns:
the number of invites/requests that the application is permitted to send per user per day.
Throws:
FacebookException
See Also:
http://wiki.developers.facebook.com/index.php/Admin.getAllocation

admin_setAppProperties

public boolean admin_setAppProperties(java.util.Map<ApplicationProperty,java.lang.String> properties)
                               throws FacebookException
Description copied from interface: IFacebookRestClient
Set application properties. The properties are used by Facebook to describe the configuration of your application. This method cannot be called by desktop apps.

Specified by:
admin_setAppProperties in interface IFacebookRestClient<T>
Parameters:
properties - a Map containing the properties to set.
Returns:
true if the properties are set successfully false otherwise
Throws:
FacebookException

admin_setAppProperties

public boolean admin_setAppProperties(ApplicationPropertySet properties)
                               throws FacebookException
Description copied from interface: IFacebookRestClient
Sets several property values for an application. The properties available are analogous to the ones editable via the Facebook Developer application. A session is not required to use this method. This method cannot be called by desktop apps.

Specified by:
admin_setAppProperties in interface IFacebookRestClient<T>
Parameters:
properties - an ApplicationPropertySet that is translated into a single JSON String.
Returns:
a boolean indicating whether the properties were successfully set
Throws:
FacebookException
See Also:
http://wiki.developers.facebook.com/index.php/Admin.setAppProperties

auth_createToken

public java.lang.String auth_createToken()
                                  throws FacebookException
Description copied from interface: IFacebookRestClient
Call this function and store the result, using it to generate the appropriate login url and then to retrieve the session information.

Specified by:
auth_createToken in interface IFacebookRestClient<T>
Returns:
an authentication token
Throws:
FacebookException
See Also:
http://wiki.developers.facebook.com/index.php/Auth.createToken

auth_expireSession

public boolean auth_expireSession()
                           throws FacebookException
Description copied from interface: IFacebookRestClient
Expires the curently active session.

Specified by:
auth_expireSession in interface IFacebookRestClient<T>
Returns:
true if the call succeeds false otherwise
Throws:
FacebookException

auth_getSession

public java.lang.String auth_getSession(java.lang.String authToken)
                                 throws FacebookException
Description copied from interface: IFacebookRestClient
Call this function to retrieve the session information after your user has logged in.

Specified by:
auth_getSession in interface IFacebookRestClient<T>
Parameters:
authToken - the token returned by auth_createToken or passed back to your callback_url.
Throws:
FacebookException
See Also:
http://wiki.developers.facebook.com/index.php/Auth.getSession

auth_getSession

public java.lang.String auth_getSession(java.lang.String authToken,
                                        boolean generateSessionSecret)
                                 throws FacebookException
Description copied from interface: IFacebookRestClient
Call this function to retrieve the session information after your user has logged in. Settings generateSessionSecret to true results in a temporary "session" secret being generated by Facebook which you can pass to a desktop client to be used in place of the real application secret. This prevents the need to reveal your application secret to users.

Specified by:
auth_getSession in interface IFacebookRestClient<T>
Parameters:
authToken - the token returned by auth_createToken or passed back to your callback_url.
generateSessionSecret - Create a temporary session secret intended for use by desktop clients
Throws:
FacebookException
See Also:
http://wiki.developers.facebook.com/index.php/Auth.getSession

auth_promoteSession

public java.lang.String auth_promoteSession()
                                     throws FacebookException
Description copied from interface: IFacebookRestClient
Generate a key for the current session that can be used to authenticate client-side components.

Specified by:
auth_promoteSession in interface IFacebookRestClient<T>
Returns:
the key.
Throws:
FacebookException

auth_revokeAuthorization

public boolean auth_revokeAuthorization()
                                 throws FacebookException
Description copied from interface: IFacebookRestClient
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.

Specified by:
auth_revokeAuthorization in interface IFacebookRestClient<T>
Returns:
true if the call succeeds false otherwise
Throws:
FacebookException

auth_revokeExtendedPermission

public boolean auth_revokeExtendedPermission(Permission perm)
                                      throws FacebookException
Specified by:
auth_revokeExtendedPermission in interface IFacebookRestClient<T>
Throws:
FacebookException
See Also:
IFacebookRestClient.auth_revokeExtendedPermission(Permission, Long), http://wiki.developers.facebook.com/index.php/Auth.revokeExtendedPermission

auth_revokeExtendedPermission

public boolean auth_revokeExtendedPermission(Permission perm,
                                             java.lang.Long userId)
                                      throws FacebookException
Description copied from interface: IFacebookRestClient
Revokes the specified extended permission for the selected user. If no user is specified, then the user of the current session is used.

Specified by:
auth_revokeExtendedPermission in interface IFacebookRestClient<T>
Parameters:
perm - The extended permission to revoke.
userId - The user ID of the user whose extended permission you want to revoke. If you don't specify this parameter, then you must have a valid session for the current user, and that session's user will have the specified permission revoked.
Returns:
This method returns true upon success.
Throws:
FacebookException
See Also:
http://wiki.developers.facebook.com/index.php/Auth.revokeExtendedPermission

connect_getUnconnectedFriendsCount

public int connect_getUnconnectedFriendsCount()
                                       throws FacebookException
Description copied from interface: IFacebookRestClient
This method returns the number of friends of the current user who have accounts on your site, but have not yet connected their accounts. Also see fb:unconnected-friends-count. You can use the response from this call to determine whether or not to display a link allowing the user to invite their friends to connect as well.

Specified by:
connect_getUnconnectedFriendsCount in interface IFacebookRestClient<T>
Returns:
This method returns an int that indicates the number of users who have not yet connected their accounts.
Throws:
FacebookException
See Also:
http://wiki.developers.facebook.com/index.php/Connect.getUnconnectedFriendsCount

dashboard_addGlobalNews

public java.lang.Long dashboard_addGlobalNews(java.util.Collection<DashboardNewsItem> newsItems)
                                       throws FacebookException
Description copied from interface: IFacebookRestClient
Non-imageUrl method signature form.

Specified by:
dashboard_addGlobalNews in interface IFacebookRestClient<T>
Throws:
FacebookException
See Also:
#dashboard_addGlobalNews(Collection, Collection, String)

dashboard_addGlobalNews

public java.lang.Long dashboard_addGlobalNews(java.util.Collection<DashboardNewsItem> newsItems,
                                              java.lang.String imageUrl)
                                       throws FacebookException
Description copied from interface: IFacebookRestClient
Submits global news items for all users of the app.

Specified by:
dashboard_addGlobalNews in interface IFacebookRestClient<T>
imageUrl - Absolute URL of image used to replace application logo in the dashboard. (optional)
Returns:
Global news item id if successful, null if unsuccessful.
Throws:
FacebookException

dashboard_clearGlobalNews

public boolean dashboard_clearGlobalNews()
                                  throws FacebookException
Description copied from interface: IFacebookRestClient
Clears all global news items from application.

Specified by:
dashboard_clearGlobalNews in interface IFacebookRestClient<T>
Returns:
True if removal of global news items was successful.
Throws:
FacebookException

dashboard_clearGlobalNews

public boolean dashboard_clearGlobalNews(java.util.Collection<java.lang.Long> newsItemIds)
                                  throws FacebookException
Description copied from interface: IFacebookRestClient
Clears specific global news items from application.

Specified by:
dashboard_clearGlobalNews in interface IFacebookRestClient<T>
Returns:
True if removal of global news items was successful.
Throws:
FacebookException

dashboard_publishActivity

public java.lang.Long dashboard_publishActivity(DashboardActivityItem activityItem)
                                         throws FacebookException
Description copied from interface: IFacebookRestClient
Non-imageUrl method signature form.

Specified by:
dashboard_publishActivity in interface IFacebookRestClient<T>
Throws:
FacebookException
See Also:
IFacebookRestClient.dashboard_publishActivity(DashboardActivityItem, String)

dashboard_publishActivity

public java.lang.Long dashboard_publishActivity(DashboardActivityItem activityItem,
                                                java.lang.String imageUrl)
                                         throws FacebookException
Description copied from interface: IFacebookRestClient
Submits activity for a given user as it will appear in the dashboard section, 'what your friends are doing'.

Specified by:
dashboard_publishActivity in interface IFacebookRestClient<T>
Parameters:
activityItem - Activity item object consisting of a message (mandatory) and an action link (optional).
imageUrl - Absolute URL of image used to replace application logo in the dashboard. (optional)
Returns:
Activity id if successful, null if unsuccessful.
Throws:
FacebookException

dashboard_multiIncrementCount

public java.util.Set<java.lang.Long> dashboard_multiIncrementCount(java.util.Collection<java.lang.Long> userIds)
                                                            throws FacebookException
Description copied from interface: IFacebookRestClient
Increments the dashboard bookmark counter by one for the given set of users.

Specified by:
dashboard_multiIncrementCount in interface IFacebookRestClient<T>
Parameters:
userIds - Users for which to update dashboard bookmark counter by one.
Returns:
Set of user ids for which operation was successful.
Throws:
FacebookException

data_createObject

public long data_createObject(java.lang.String objectType,
                              java.util.Map<java.lang.String,java.lang.String> properties)
                       throws FacebookException
Description copied from interface: IFacebookRestClient
Create object in Data Store

Specified by:
data_createObject in interface IFacebookRestClient<T>
Parameters:
objectType - Specifies which type of new object to create.
properties - Optional - Name-value pairs of properties this new object has
Returns:
64-bit integer: Numeric identifier (fbid) of newly created object.
Throws:
FacebookException
See Also:
Developers Wiki: Data.createObject

data_getAssociatedObjectCount

public long data_getAssociatedObjectCount(java.lang.String associationName,
                                          long objectId)
                                   throws FacebookException
Description copied from interface: IFacebookRestClient
Returns count of object ids that are associated with specified object. This function takes constant time to return the count, regardless how many objects are associated.

Specified by:
data_getAssociatedObjectCount in interface IFacebookRestClient<T>
Parameters:
associationName - Name of the association.
objectId - Object identifier.
Returns:
int64 object count
Throws:
FacebookException
See Also:
Developers Wiki: Data.getAssociatedObjectCount

data_getUserPreference

public java.lang.String data_getUserPreference(int prefId)
                                        throws FacebookException
Description copied from interface: IFacebookRestClient
Lookup a single preference value for the current user.

Specified by:
data_getUserPreference in interface IFacebookRestClient<T>
Parameters:
prefId - the id of the preference to lookup. This should be an integer value from 0-200.
Returns:
The value of that preference, or null if it is not yet set.
Throws:
FacebookException - if an error happens when executing the API call.

data_setCookie

public boolean data_setCookie(java.lang.String name,
                              java.lang.String value)
                       throws FacebookException
Description copied from interface: IFacebookRestClient
Set a cookie for the current user. It will use the default expiry (never), and the default path ("/").

Specified by:
data_setCookie in interface IFacebookRestClient<T>
Parameters:
name - the name of the cookie to set
value - the value of the cookie
Returns:
true if the cookie is set successfully, false otherwise.
Throws:
FacebookException

data_setCookie

public boolean data_setCookie(java.lang.String name,
                              java.lang.String value,
                              java.lang.String path)
                       throws FacebookException
Description copied from interface: IFacebookRestClient
Set a cookie for the current user, under the specified path. It will use the default expiry (never).

Specified by:
data_setCookie in interface IFacebookRestClient<T>
Parameters:
name - the name of the cookie to set
value - the value of the cookie
path - the path relative to the application's callback URL, with which the cookie should be associated. (default is "/")
Returns:
true if the cookie is set successfully, false otherwise.
Throws:
FacebookException

data_setCookie

public boolean data_setCookie(java.lang.Long userId,
                              java.lang.CharSequence name,
                              java.lang.CharSequence value)
                       throws FacebookException
Description copied from interface: IFacebookRestClient
Set a cookie for the specified user. The cookie will use the default expiry (never) and the default path ("/").

Specified by:
data_setCookie in interface IFacebookRestClient<T>
Parameters:
userId - the id of the user to set the cookie for.
name - the name of the cookie to set
value - the value of the cookie
Returns:
true if the cookie is set successfully, false otherwise.
Throws:
FacebookException

data_setCookie

public boolean data_setCookie(java.lang.Long userId,
                              java.lang.CharSequence name,
                              java.lang.CharSequence value,
                              java.lang.CharSequence path)
                       throws FacebookException
Description copied from interface: IFacebookRestClient
Set a cookie for the specified user, with the specified path. The cookie will use the default expiry (never).

Specified by:
data_setCookie in interface IFacebookRestClient<T>
Parameters:
userId - the id of the user to set the cookie for.
name - the name of the cookie to set
value - the value of the cookie
path - the path relative to the application's callback URL, with which the cookie should be associated. (default is "/")
Returns:
true if the cookie is set successfully, false otherwise.
Throws:
FacebookException

data_setCookie

public boolean data_setCookie(java.lang.String name,
                              java.lang.String value,
                              java.lang.Long expires)
                       throws FacebookException
Description copied from interface: IFacebookRestClient
Set a cookie for the current user, with the specified expiration date. It will use the default path ("/").

Specified by:
data_setCookie in interface IFacebookRestClient<T>
Parameters:
name - the name of the cookie to set
value - the value of the cookie
expires - the timestamp at which the cookie expires
Returns:
true if the cookie is set successfully, false otherwise.
Throws:
FacebookException

data_setCookie

public boolean data_setCookie(java.lang.String name,
                              java.lang.String value,
                              java.lang.Long expires,
                              java.lang.String path)
                       throws FacebookException
Description copied from interface: IFacebookRestClient
Set a cookie for the current user, with the specified expiration date and path.

Specified by:
data_setCookie in interface IFacebookRestClient<T>
Parameters:
name - the name of the cookie to set
value - the value of the cookie
expires - the timestamp at which the cookie expires
path - the path relative to the application's callback URL, with which the cookie should be associated. (default is "/")
Returns:
true if the cookie is set successfully, false otherwise.
Throws:
FacebookException

data_setCookie

public boolean data_setCookie(java.lang.Long userId,
                              java.lang.CharSequence name,
                              java.lang.CharSequence value,
                              java.lang.Long expires)
                       throws FacebookException
Description copied from interface: IFacebookRestClient
Set a cookie for the specified user, with the specified expiration date. The cookie will use the default path ("/").

Specified by:
data_setCookie in interface IFacebookRestClient<T>
Parameters:
userId - the id of the user to set the cookie for.
name - the name of the cookie to set
value - the value of the cookie
expires - the timestamp at which the cookie expires
Returns:
true if the cookie is set successfully, false otherwise.
Throws:
FacebookException

data_setCookie

public boolean data_setCookie(java.lang.Long userId,
                              java.lang.CharSequence name,
                              java.lang.CharSequence value,
                              java.lang.Long expires,
                              java.lang.CharSequence path)
                       throws FacebookException
Description copied from interface: IFacebookRestClient
Set a cookie for the specified user, with the specified expiration date and path.

Specified by:
data_setCookie in interface IFacebookRestClient<T>
Parameters:
userId - the id of the user to set the cookie for.
name - the name of the cookie to set
value - the value of the cookie
expires - the timestamp at which the cookie expires
path - the path relative to the application's callback URL, with which the cookie should be associated. (default is "/")
Returns:
true if the cookie is set successfully, false otherwise.
Throws:
FacebookException

events_cancel

public boolean events_cancel(java.lang.Long eid,
                             java.lang.String cancel_message)
                      throws FacebookException
Description copied from interface: IFacebookRestClient
Cancels an event. The application must be an admin of the event. An application is the admin of an event if the application created the event on behalf of a user (with that user's active session) or if it is the creator of the event itself (that is, the event was created without an active user session).

Specified by:
events_cancel in interface IFacebookRestClient<T>
Parameters:
eid - The event ID.
cancel_message - The message sent explaining why the event was canceled. You can pass an empty string if you don't want to provide an explanation.
Throws:
FacebookException
See Also:
http://wiki.developers.facebook.com/index.php/Events.cancel

events_create

public java.lang.Long events_create(java.util.Map<java.lang.String,java.lang.String> event_info)
                             throws FacebookException
Description copied from interface: IFacebookRestClient
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.

Specified by:
events_create in interface IFacebookRestClient<T>
Parameters:
event_info - The event information. You must pass the following parameters:
  • name
  • category
  • subcategory
  • host
  • location
  • city
  • start_time (seconds since epoch)
  • end_time (seconds since epoch)
Optionally, you can pass the following parameters in the event_info array:
  • street
  • phone
  • email
  • page_id
  • description
  • privacy_type
  • tagline
Throws:
FacebookException
See Also:
http://wiki.developers.facebook.com/index.php/Events.create

events_edit

public boolean events_edit(java.lang.Long eid,
                           java.util.Map<java.lang.String,java.lang.String> event_info)
                    throws FacebookException
Description copied from interface: IFacebookRestClient
Edits the details of an existing event. The application must be an admin of the event. An application is the admin of an event if the application created the event on behalf of a user (with that user's active session) or if it is the creator of the event itself (that is, the event was created without an active user session).

Specified by:
events_edit in interface IFacebookRestClient<T>
Parameters:
eid - The event ID.
Throws:
FacebookException
See Also:
http://wiki.developers.facebook.com/index.php/Events.edit

events_rsvp

public boolean events_rsvp(java.lang.Long eid,
                           java.lang.String rsvp_status)
                    throws FacebookException
Description copied from interface: IFacebookRestClient
Sets a user's RSVP status for an event. An application can set a user's RSVP status only if the following are all true:

Specified by:
events_rsvp in interface IFacebookRestClient<T>
Parameters:
eid - The event ID.
rsvp_status - The user's RSVP status. Specify attending, unsure, or declined.
Throws:
FacebookException
See Also:
http://wiki.developers.facebook.com/index.php/Events.rsvp

fbml_refreshImgSrc

public boolean fbml_refreshImgSrc(java.lang.String imageUrl)
                           throws FacebookException
Description copied from interface: IFacebookRestClient
Recaches the image with the specified imageUrl.

Specified by:
fbml_refreshImgSrc in interface IFacebookRestClient<T>
Parameters:
imageUrl - String representing the image URL to refresh
Returns:
boolean indicating whether the refresh succeeded
Throws:
FacebookException

fbml_refreshImgSrc

public boolean fbml_refreshImgSrc(java.net.URL imageUrl)
                           throws FacebookException
Description copied from interface: IFacebookRestClient
Recaches the image with the specified imageUrl.

Specified by:
fbml_refreshImgSrc in interface IFacebookRestClient<T>
Parameters:
imageUrl - the image URL to refresh
Returns:
boolean indicating whether the refresh succeeded
Throws:
FacebookException

fbml_refreshRefUrl

public boolean fbml_refreshRefUrl(java.lang.String url)
                           throws FacebookException
Description copied from interface: IFacebookRestClient
Recaches the referenced url.

Specified by:
fbml_refreshRefUrl in interface IFacebookRestClient<T>
Parameters:
url - string representing the URL to refresh
Returns:
boolean indicating whether the refresh succeeded
Throws:
FacebookException

fbml_refreshRefUrl

public boolean fbml_refreshRefUrl(java.net.URL url)
                           throws FacebookException
Description copied from interface: IFacebookRestClient
Recaches the referenced url.

Specified by:
fbml_refreshRefUrl in interface IFacebookRestClient<T>
Parameters:
url - the URL to refresh
Returns:
boolean indicating whether the refresh succeeded
Throws:
FacebookException

fbml_setRefHandle

public boolean fbml_setRefHandle(java.lang.String handle,
                                 java.lang.String markup)
                          throws FacebookException
Description copied from interface: IFacebookRestClient
Associates the specified FBML markup with the specified handle/id. The markup can then be referenced using the fb:ref FBML tag, to allow a given snippet to be reused easily across multiple users, and also to allow the application to update the fbml for multiple users more easily without having to make a seperate call for each user, by just changing the FBML markup that is associated with the handle/id. This method cannot be called by desktop apps.

Specified by:
fbml_setRefHandle in interface IFacebookRestClient<T>
Parameters:
handle - the id to associate the specified markup with. Put this in fb:ref FBML tags to reference your markup.
markup - the FBML markup to store.
Throws:
FacebookException - if an error happens when executing the API call.

feed_PublishTemplatizedAction

@Deprecated
public boolean feed_PublishTemplatizedAction(TemplatizedAction action)
                                      throws FacebookException
Deprecated. 

Description copied from interface: IFacebookRestClient
Publishes a templatized action for the current user. The action will appear in their minifeed, and may appear in their friends' newsfeeds depending upon a number of different factors. When a template match exists between multiple distinct users (like "Bob recommends Bizou" and "Sally recommends Bizou"), the feed entries may be combined in the newfeed (to something like "Bob and sally recommend Bizou"). This happens automatically, and *only* if the template match between the two feed entries is identical.

Feed entries are not aggregated for a single user (so "Bob recommends Bizou" and "Bob recommends Le Charm" *will not* become "Bob recommends Bizou and Le Charm").

If the user's action involves one or more of their friends, list them in the 'targetIds' parameter. For example, if you have "Bob says hi to Sally and Susie", and Sally's UID is 1, and Susie's UID is 2, then pass a 'targetIds' paramters of "1,2". If you pass this parameter, you can use the "{target}" token in your templates. Probably it also makes it more likely that Sally and Susie will see the feed entry in their newsfeed, relative to any other friends Bob might have. It may be a good idea to always send a list of all the user's friends, and avoid using the "{target}" token, to maximize distribution of the story through the newsfeed.

The only strictly required parameter is 'titleTemplate', which must contain the "{actor}" token somewhere inside of it. All other parameters, options, and tokens are optional, and my be set to null if being omitted.

Not that stories will only be aggregated if *all* templates match and *all* template parameters match, so if two entries have the same templateTitle and titleData, but a different bodyTemplate, they will not aggregate. Probably it's better to use bodyGeneral instead of bodyTemplate, for the extra flexibility it provides.


Note that this method is replacing 'feed_publishActionOfUser', which has been deprecated by Facebook. For specific details, visit http://wiki.developers.facebook.com/index.php/Feed.publishTemplatizedAction

Specified by:
feed_PublishTemplatizedAction in interface IFacebookRestClient<T>
Parameters:
action - a TemplatizedAction instance that represents the feed data to publish
Returns:
a Document representing the XML response returned from the Facebook API server.
Throws:
FacebookException - if any number of bad things happen

feed_deactivateTemplateBundleByID

@Deprecated
public boolean feed_deactivateTemplateBundleByID(java.lang.Long bundleId)
                                          throws FacebookException
Deprecated. 

Description copied from interface: IFacebookRestClient
Deactivates the specified template bundle.

Specified by:
feed_deactivateTemplateBundleByID in interface IFacebookRestClient<T>
Parameters:
bundleId - the id of the bundle to deactivate.
Returns:
true if the call succeeds, false otherwise.
Throws:
FacebookException

feed_publishTemplatizedAction

@Deprecated
public boolean feed_publishTemplatizedAction(java.lang.Long actorId,
                                                        java.lang.CharSequence titleTemplate)
                                      throws FacebookException
Deprecated. 

Description copied from interface: IFacebookRestClient
Publishes a Mini-Feed story describing an action taken by a user, and publishes aggregating News Feed stories to the friends of that user. Stories are identified as being combinable if they have matching templates and substituted values.

Specified by:
feed_publishTemplatizedAction in interface IFacebookRestClient<T>
Parameters:
actorId - deprecated
titleTemplate - markup (up to 60 chars, tags excluded) for the feed story's title section. Must include the token {actor}.
Returns:
whether the action story was successfully published; false in case of a permission error
Throws:
FacebookException
See Also:
Developers Wiki: Feed.publishTemplatizedAction, Developers Resources: Feed Preview Console

feed_publishTemplatizedAction

@Deprecated
public boolean feed_publishTemplatizedAction(java.lang.CharSequence titleTemplate)
                                      throws FacebookException
Deprecated. 

Description copied from interface: IFacebookRestClient
Publishes a Mini-Feed story describing an action taken by the logged-in user, and publishes aggregating News Feed stories to their friends. Stories are identified as being combinable if they have matching templates and substituted values.

Specified by:
feed_publishTemplatizedAction in interface IFacebookRestClient<T>
Parameters:
titleTemplate - markup (up to 60 chars, tags excluded) for the feed story's title section. Must include the token {actor}.
Returns:
whether the action story was successfully published; false in case of a permission error
Throws:
FacebookException
See Also:
Developers Wiki: Feed.publishTemplatizedAction, Developers Resources: Feed Preview Console

feed_publishTemplatizedAction

@Deprecated
public boolean feed_publishTemplatizedAction(java.lang.CharSequence titleTemplate,
                                                        java.lang.Long pageActorId)
                                      throws FacebookException
Deprecated. 

Description copied from interface: IFacebookRestClient
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. Stories are identified as being combinable if they have matching templates and substituted values.

Specified by:
feed_publishTemplatizedAction in interface IFacebookRestClient<T>
Parameters:
titleTemplate - markup (up to 60 chars, tags excluded) for the feed story's title section. Must include the token {actor}.
pageActorId - (optional) the ID of the page into whose mini-feed the story is being published
Returns:
whether the action story was successfully published; false in case of a permission error
Throws:
FacebookException
See Also:
Developers Wiki: Feed.publishTemplatizedAction, Developers Resources: Feed Preview Console

feed_publishTemplatizedAction

@Deprecated
public 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)
                                      throws FacebookException
Deprecated. 

Description copied from interface: IFacebookRestClient
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. Stories are identified as being combinable if they have matching templates and substituted values.

Specified by:
feed_publishTemplatizedAction in interface IFacebookRestClient<T>
Parameters:
titleTemplate - markup (up to 60 chars, tags excluded) for the feed story's title section. Must include the token {actor}.
titleData - (optional) contains token-substitution mappings for tokens that appear in titleTemplate. Should not contain mappings for the {actor} or {target} tokens. Required if tokens other than {actor} or {target} appear in the titleTemplate.
bodyTemplate - (optional) markup to be displayed in the feed story's body section. can include tokens, of the form {token}, to be substituted using bodyData.
bodyData - (optional) contains token-substitution mappings for tokens that appear in bodyTemplate. Required if the bodyTemplate contains tokens other than {actor} and {target}.
bodyGeneral - (optional) additional body markup that is not aggregated. If multiple instances of this templated story are combined together, the markup in the bodyGeneral of one of their stories may be displayed.
targetIds - The user ids of friends of the actor, used for stories about a direct action between the actor and these targets of his/her action. Required if either the titleTemplate or bodyTemplate includes the token {target}.
images - (optional) additional body markup that is not aggregated. If multiple instances of this templated story are combined together, the markup in the bodyGeneral of one of their stories may be displayed.
pageActorId - (optional) the ID of the page into whose mini-feed the story is being published
Returns:
whether the action story was successfully published; false in case of a permission error
Throws:
FacebookException
See Also:
Developers Wiki: Feed.publishTemplatizedAction, Developers Resources: Feed Preview Console

feed_publishTemplatizedAction

@Deprecated
public 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)
                                      throws FacebookException
Deprecated. 

Description copied from interface: IFacebookRestClient
Publishes a Mini-Feed story describing an action taken by a user, and publishes aggregating News Feed stories to the friends of that user. Stories are identified as being combinable if they have matching templates and substituted values.

Specified by:
feed_publishTemplatizedAction in interface IFacebookRestClient<T>
Parameters:
actorId - the user into whose mini-feed the story is being published.
titleTemplate - markup (up to 60 chars, tags excluded) for the feed story's title section. Must include the token {actor}.
titleData - (optional) contains token-substitution mappings for tokens that appear in titleTemplate. Should not contain mappings for the {actor} or {target} tokens. Required if tokens other than {actor} or {target} appear in the titleTemplate.
bodyTemplate - (optional) markup to be displayed in the feed story's body section. can include tokens, of the form {token}, to be substituted using bodyData.
bodyData - (optional) contains token-substitution mappings for tokens that appear in bodyTemplate. Required if the bodyTemplate contains tokens other than {actor} and {target}.
bodyGeneral - (optional) additional body markup that is not aggregated. If multiple instances of this templated story are combined together, the markup in the bodyGeneral of one of their stories may be displayed.
targetIds - The user ids of friends of the actor, used for stories about a direct action between the actor and these targets of his/her action. Required if either the titleTemplate or bodyTemplate includes the token {target}.
images - (optional) additional body markup that is not aggregated. If multiple instances of this templated story are combined together, the markup in the bodyGeneral of one of their stories may be displayed.
Returns:
whether the action story was successfully published; false in case of a permission error
Throws:
FacebookException
See Also:
Developers Wiki: Feed.publishTemplatizedAction

feed_publishTemplatizedAction

@Deprecated
public 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)
                                      throws FacebookException
Deprecated. 

Description copied from interface: IFacebookRestClient
Publishes a templatized action for the current user. The action will appear in their minifeed, and may appear in their friends' newsfeeds depending upon a number of different factors. When a template match exists between multiple distinct users (like "Bob recommends Bizou" and "Sally recommends Bizou"), the feed entries may be combined in the newfeed (to something like "Bob and sally recommend Bizou"). This happens automatically, and *only* if the template match between the two feed entries is identical.

Feed entries are not aggregated for a single user (so "Bob recommends Bizou" and "Bob recommends Le Charm" *will not* become "Bob recommends Bizou and Le Charm").

If the user's action involves one or more of their friends, list them in the 'targetIds' parameter. For example, if you have "Bob says hi to Sally and Susie", and Sally's UID is 1, and Susie's UID is 2, then pass a 'targetIds' paramters of "1,2". If you pass this parameter, you can use the "{target}" token in your templates. Probably it also makes it more likely that Sally and Susie will see the feed entry in their newsfeed, relative to any other friends Bob might have. It may be a good idea to always send a list of all the user's friends, and avoid using the "{target}" token, to maximize distribution of the story through the newsfeed.

The only strictly required parameter is 'titleTemplate', which must contain the "{actor}" token somewhere inside of it. All other parameters, options, and tokens are optional, and my be set to null if being omitted.

Not that stories will only be aggregated if *all* templates match and *all* template parameters match, so if two entries have the same templateTitle and titleData, but a different bodyTemplate, they will not aggregate. Probably it's better to use bodyGeneral instead of bodyTemplate, for the extra flexibility it provides.


Note that this method is replacing 'feed_publishActionOfUser', which has been deprecated by Facebook. For specific details, visit http://wiki.developers.facebook.com/index.php/Feed.publishTemplatizedAction

Specified by:
feed_publishTemplatizedAction in interface IFacebookRestClient<T>
Parameters:
titleTemplate - the template for the title of the feed entry, this must contain the "(actor}" token. Any other tokens are optional, i.e. "{actor} recommends {place}".
titleData - JSON-formatted values for any tokens used in titleTemplate, with the exception of "{actor}" and "{target}", which Facebook populates automatically, i.e. "{place: "Bizou"}".
bodyTemplate - the template for the body of the feed entry, works the same as 'titleTemplate', but is not required to contain the "{actor}" token.
bodyData - works the same as titleData
bodyGeneral - non-templatized content for the body, may contain markup, may not contain tokens.
pictures - a list of up to 4 images to display, with optional hyperlinks for each one.
targetIds - a comma-seperated list of the UID's of any friend(s) who are involved in this feed action (if there are any), this specifies the value of the "{target}" token. If you use this token in any of your templates, you must specify a value for this parameter.
Returns:
a Document representing the XML response returned from the Facebook API server.
Throws:
FacebookException - if any number of bad things happen

feed_publishTemplatizedAction

@Deprecated
public 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)
                                      throws FacebookException
Deprecated. 

Description copied from interface: IFacebookRestClient
Publishes a Mini-Feed story describing an action taken by a user, and publishes aggregating News Feed stories to the friends of that user. Stories are identified as being combinable if they have matching templates and substituted values.

Specified by:
feed_publishTemplatizedAction in interface IFacebookRestClient<T>
Parameters:
actorId - the user into whose mini-feed the story is being published.
titleTemplate - markup (up to 60 chars, tags excluded) for the feed story's title section. Must include the token {actor}.
titleData - (optional) contains token-substitution mappings for tokens that appear in titleTemplate. Should not contain mappings for the {actor} or {target} tokens. Required if tokens other than {actor} or {target} appear in the titleTemplate.
bodyTemplate - (optional) markup to be displayed in the feed story's body section. can include tokens, of the form {token}, to be substituted using bodyData.
bodyData - (optional) contains token-substitution mappings for tokens that appear in bodyTemplate. Required if the bodyTemplate contains tokens other than {actor} and {target}.
bodyGeneral - (optional) additional body markup that is not aggregated. If multiple instances of this templated story are combined together, the markup in the bodyGeneral of one of their stories may be displayed.
targetIds - The user ids of friends of the actor, used for stories about a direct action between the actor and these targets of his/her action. Required if either the titleTemplate or bodyTemplate includes the token {target}.
images - (optional) additional body markup that is not aggregated. If multiple instances of this templated story are combined together, the markup in the bodyGeneral of one of their stories may be displayed.
Returns:
whether the action story was successfully published; false in case of a permission error
Throws:
FacebookException
See Also:
Developers Wiki: Feed.publishTemplatizedAction, Developers Resources: Feed Preview Console

feed_publishUserAction

@Deprecated
public java.lang.Boolean feed_publishUserAction(java.lang.Long bundleId)
                                         throws FacebookException
Deprecated. 

Description copied from interface: IFacebookRestClient
Publishes a user action to the feed. See: http://wiki.developers.facebook.com/index.php/Feed.publishUserAction

Specified by:
feed_publishUserAction in interface IFacebookRestClient<T>
Parameters:
bundleId - the template bundle-id to use to render the feed.
Returns:
true if the call succeeds false otherwise
Throws:
FacebookException

feed_publishUserAction

@Deprecated
public 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)
                                         throws FacebookException
Deprecated. 

Description copied from interface: IFacebookRestClient
Publishes a user action to the feed. See: http://wiki.developers.facebook.com/index.php/Feed.publishUserAction

Specified by:
feed_publishUserAction in interface IFacebookRestClient<T>
Parameters:
bundleId - the template bundle-id to use to render the feed.
templateData - a map of name-value pairs to substitute into the template being rendered.
targetIds - the ids of individuals that are the target of this action.
bodyGeneral - additional markup to include in the feed story.
Returns:
true if the call succeeds false otherwise
Throws:
FacebookException

feed_publishUserAction

@Deprecated
public 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)
                                         throws FacebookException
Deprecated. 

Description copied from interface: IFacebookRestClient
Publishes a user action to the feed. See: http://wiki.developers.facebook.com/index.php/Feed.publishUserAction

Specified by:
feed_publishUserAction in interface IFacebookRestClient<T>
Parameters:
bundleId - the template bundle-id to use to render the feed.
templateData - a map of name-value pairs to substitute into the template being rendered.
images - the images to associate with this feed entry
targetIds - the ids of individuals that are the target of this action.
bodyGeneral - additional markup to include in the feed story.
storySize - story size to use. valid values are 1, 2 or 4.
Returns:
true if the call succeeds false otherwise
Throws:
FacebookException

feed_registerTemplateBundle

@Deprecated
public java.lang.Long feed_registerTemplateBundle(java.lang.String template)
                                           throws FacebookException
Deprecated. 

Description copied from interface: IFacebookRestClient
Registers a feed template. See: http://wiki.developers.facebook.com/index.php/Feed.registerTemplateBundle

Specified by:
feed_registerTemplateBundle in interface IFacebookRestClient<T>
Parameters:
template - the template to store
Returns:
the id which Facebook assigns to your template
Throws:
FacebookException

feed_registerTemplateBundle

@Deprecated
public java.lang.Long feed_registerTemplateBundle(java.util.Collection<java.lang.String> templates)
                                           throws FacebookException
Deprecated. 

Description copied from interface: IFacebookRestClient
Registers a feed template. See: http://wiki.developers.facebook.com/index.php/Feed.registerTemplateBundle

Specified by:
feed_registerTemplateBundle in interface IFacebookRestClient<T>
Parameters:
templates - the templates to store
Returns:
the id which Facebook assigns to your template
Throws:
FacebookException

feed_registerTemplateBundle

@Deprecated
public java.lang.Long feed_registerTemplateBundle(java.lang.String template,
                                                             java.lang.String shortTemplate,
                                                             java.lang.String longTemplate)
                                           throws FacebookException
Deprecated. 

Description copied from interface: IFacebookRestClient
Registers a feed template. See: http://wiki.developers.facebook.com/index.php/Feed.registerTemplateBundle

Specified by:
feed_registerTemplateBundle in interface IFacebookRestClient<T>
Parameters:
template - the template to store.
shortTemplate - the short template to store.
longTemplate - the long template to store.
Returns:
the id which Facebook assigns to your template
Throws:
FacebookException

feed_registerTemplateBundle

@Deprecated
public java.lang.Long feed_registerTemplateBundle(java.util.Collection<java.lang.String> templates,
                                                             java.util.Collection<BundleStoryTemplate> shortTemplates,
                                                             BundleStoryTemplate longTemplate,
                                                             java.util.List<BundleActionLink> actionLinks)
                                           throws FacebookException
Deprecated. 

Description copied from interface: IFacebookRestClient
Registers a feed template. See: http://wiki.developers.facebook.com/index.php/Feed.registerTemplateBundle

Specified by:
feed_registerTemplateBundle in interface IFacebookRestClient<T>
longTemplate - the long template to store.
actionLinks - the action links to store
Returns:
the id which Facebook assigns to your template
Throws:
FacebookException

feed_registerTemplateBundle

@Deprecated
public java.lang.Long feed_registerTemplateBundle(java.util.Collection<java.lang.String> templates,
                                                             java.util.Collection<BundleStoryTemplate> shortTemplates,
                                                             BundleStoryTemplate longTemplate)
                                           throws FacebookException
Deprecated. 

Description copied from interface: IFacebookRestClient
Registers a feed template. See: http://wiki.developers.facebook.com/index.php/Feed.registerTemplateBundle

Specified by:
feed_registerTemplateBundle in interface IFacebookRestClient<T>
longTemplate - the long template to store.
Returns:
the id which Facebook assigns to your template
Throws:
FacebookException

getCacheAppUser

@Deprecated
public java.lang.Boolean getCacheAppUser()
Deprecated. 

Specified by:
getCacheAppUser in interface IFacebookRestClient<T>

getCacheSessionExpires

public java.lang.Long getCacheSessionExpires()
Specified by:
getCacheSessionExpires in interface IFacebookRestClient<T>

getCacheSessionKey

public java.lang.String getCacheSessionKey()
Specified by:
getCacheSessionKey in interface IFacebookRestClient<T>

getCacheUserId

public java.lang.Long getCacheUserId()
Specified by:
getCacheUserId in interface IFacebookRestClient<T>

isDesktop

public boolean isDesktop()
Description copied from interface: IFacebookRestClient
Check to see if the client is running in desktop-app mode

Specified by:
isDesktop in interface IFacebookRestClient<T>
Returns:
true if the app is running in desktop mode. false otherwise

liveMessage_send

public java.lang.Boolean liveMessage_send(java.lang.Long recipient,
                                          java.lang.String eventName,
                                          org.json.JSONObject message)
                                   throws FacebookException
Description copied from interface: IFacebookRestClient
Sends a message using the LiveMessage API. Note that for the message to be recieved by the recipent, you must set up a FBJS handler function. See http://wiki.developers.facebook.com/index.php/LiveMessage for details.

Specified by:
liveMessage_send in interface IFacebookRestClient<T>
Parameters:
recipient - the id of the user to send the message to.
eventName - the name associated with the FBJS handler you want to recieve your message.
message - the JSON-object to send, the object will be passed to the FBJS handler that you have mapped to 'eventName'. See http://wiki.developers.facebook.com/index.php/LiveMessage for details.
Returns:
true if the message is sent, false otherwise
Throws:
FacebookException

notifications_send

@Deprecated
public java.util.Collection<java.lang.String> notifications_send(java.util.Collection<java.lang.Long> recipientIds,
                                                                            java.lang.CharSequence notification)
                                                          throws FacebookException
Deprecated. 

Description copied from interface: IFacebookRestClient
Send a notification message to the specified users.

Specified by:
notifications_send in interface IFacebookRestClient<T>
Parameters:
recipientIds - the user ids to which the message is to be sent.
notification - the FBML to display on the notifications page.
Throws:
FacebookException

notifications_send

@Deprecated
public java.util.Collection<java.lang.String> notifications_send(java.lang.CharSequence notification)
                                                          throws FacebookException
Deprecated. 

Description copied from interface: IFacebookRestClient
Send a notification message to the logged-in user.

Specified by:
notifications_send in interface IFacebookRestClient<T>
Parameters:
notification - the FBML to be displayed on the notifications page; only a stripped-down set of FBML tags that result in text and links is allowed
Returns:
a URL, possibly null, to which the user should be redirected to finalize the sending of the email
Throws:
FacebookException
See Also:
Developers Wiki: notifications.send

notifications_send

@Deprecated
public java.util.Collection<java.lang.String> notifications_send(java.util.Collection<java.lang.Long> recipientIds,
                                                                            java.lang.String notification,
                                                                            boolean isAppToUser)
                                                          throws FacebookException
Deprecated. 

Description copied from interface: IFacebookRestClient
Sends a notification.

Specified by:
notifications_send in interface IFacebookRestClient<T>
Parameters:
recipientIds - the ids of the users to send the notification to.
notification - the notification to send.
Throws:
FacebookException
See Also:
http://wiki.developers.facebook.com/index.php/Notifications.send

notifications_sendEmailToCurrentUser

public java.util.Collection<java.lang.String> notifications_sendEmailToCurrentUser(java.lang.String subject,
                                                                                   java.lang.String email,
                                                                                   java.lang.String fbml)
                                                                            throws FacebookException
Description copied from interface: IFacebookRestClient
Send an e-mail to the currently logged-in user. The e-mail content can be specified as either plaintext or FBML. In either case, only a limited subset of markup is supported (only tags that result in text and links are allowed). You must include at least one of either the fbml or email parameters, but you do not ever need to specify both at once (the other can be null, or ""). If you specify both a text version and a fbml version of your e-mail, the text version will be used.

Specified by:
notifications_sendEmailToCurrentUser in interface IFacebookRestClient<T>
Parameters:
subject - the subject of the email message.
email - a plaintext version of the email to send.
fbml - an FBML version of the email to send, the fbml parameter is a stripped-down set of FBML that allows only tags that result in text, links and linebreaks.
Returns:
a list of user-ids specifying which users were successfully emailed.
Throws:
FacebookException - if an error happens when executing the API call.

notifications_sendEmail

public 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)
                                                               throws FacebookException
Description copied from interface: IFacebookRestClient
Send an e-mail to a set of app-users. You can only e-mail users who have already added your application. The e-mail content can be specified as either plaintext or FBML. In either case, only a limited subset of markup is supported (only tags that result in text and links are allowed). You must include at least one of either the fbml or email parameters, but you do not ever need to specify both at once (the other can be null, or ""). If you specify both a text version and a fbml version of your e-mail, the text version will be used.

Specified by:
notifications_sendEmail in interface IFacebookRestClient<T>
Parameters:
recipients - the uid's of the users to send to.
subject - the subject of the email message.
email - a plaintext version of the email to send.
fbml - an FBML version of the email to send, the fbml parameter is a stripped-down set of FBML that allows only tags that result in text, links and linebreaks.
Returns:
a list of user-ids specifying which users were successfully emailed.
Throws:
FacebookException - if an error happens when executing the API call.

notifications_sendTextEmailToCurrentUser

public java.util.Collection<java.lang.String> notifications_sendTextEmailToCurrentUser(java.lang.String subject,
                                                                                       java.lang.String email)
                                                                                throws FacebookException
Description copied from interface: IFacebookRestClient
Send an e-mail to the currently logged-in user. The e-mail must be specified as plaintext, and can contain a limited subset of HTML tags (specifically, only tags that result in text and links).

Specified by:
notifications_sendTextEmailToCurrentUser in interface IFacebookRestClient<T>
Parameters:
subject - the subject of the email message.
email - a plaintext version of the email to send.
Returns:
a list of user-ids specifying which users were successfully emailed.
Throws:
FacebookException - if an error happens when executing the API call.

notifications_sendTextEmail

public java.util.Collection<java.lang.String> notifications_sendTextEmail(java.util.Collection<java.lang.Long> recipients,
                                                                          java.lang.String subject,
                                                                          java.lang.String email)
                                                                   throws FacebookException
Description copied from interface: IFacebookRestClient
Send an e-mail to a set of app-users. You can only e-mail users who have already added your application. The e-mail content can be specified as either plaintext or FBML. In either case, only a limited subset of markup is supported (only tags that result in text and links are allowed).

Specified by:
notifications_sendTextEmail in interface IFacebookRestClient<T>
Parameters:
recipients - the uid's of the users to send to.
subject - the subject of the email message.
email - a plaintext version of the email to send.
Returns:
a list of user-ids specifying which users were successfully emailed.
Throws:
FacebookException - if an error happens when executing the API call.

notifications_sendFbmlEmailToCurrentUser

public java.util.Collection<java.lang.String> notifications_sendFbmlEmailToCurrentUser(java.lang.String subject,
                                                                                       java.lang.String fbml)
                                                                                throws FacebookException
Description copied from interface: IFacebookRestClient
Send an e-mail to the currently logged-in user. The e-mail must be specified as fbml, and can contain a limited subset of FBML tags (specifically, only tags that result in text and links).

Specified by:
notifications_sendFbmlEmailToCurrentUser in interface IFacebookRestClient<T>
Parameters:
subject - the subject of the email message.
fbml - the FBML version of the email to send, the fbml parameter is a stripped-down set of FBML that allows only tags that result in text, links and linebreaks.
Returns:
a list of user-ids specifying which users were successfully emailed.
Throws:
FacebookException - if an error happens when executing the API call.

notifications_sendFbmlEmail

public java.util.Collection<java.lang.String> notifications_sendFbmlEmail(java.util.Collection<java.lang.Long> recipients,
                                                                          java.lang.String subject,
                                                                          java.lang.String fbml)
                                                                   throws FacebookException
Description copied from interface: IFacebookRestClient
Send an e-mail to a set of app-users. You can only e-mail users who have already added your application. The e-mail content can be specified as either plaintext or FBML. In either case, only a limited subset of markup is supported (only tags that result in text and links are allowed).

Specified by:
notifications_sendFbmlEmail in interface IFacebookRestClient<T>
Parameters:
recipients - the uid's of the users to send to.
subject - the subject of the email message.
fbml - the FBML version of the email to send, the fbml parameter is a stripped-down set of FBML that allows only tags that result in text, links and linebreaks.
Returns:
a list of user-ids specifying which users were successfully emailed.
Throws:
FacebookException - if an error happens when executing the API call.

notifications_send

@Deprecated
public java.net.URL notifications_send(java.util.Collection<java.lang.Long> recipientIds,
                                                  java.lang.CharSequence notification,
                                                  java.lang.CharSequence email)
                                throws FacebookException
Deprecated. 

Description copied from interface: IFacebookRestClient
Send a notification message to the specified users.

Specified by:
notifications_send in interface IFacebookRestClient<T>
Parameters:
recipientIds - the user ids to which the message is to be sent
notification - the FBML to display on the notifications page
email - the FBML to send to the specified users via email, or null if no email should be sent
Returns:
a URL, possibly null, to which the user should be redirected to finalize the sending of the email
Throws:
FacebookException

notifications_sendEmail

@Deprecated
public java.lang.String notifications_sendEmail(java.util.Collection<java.lang.Long> recipientIds,
                                                           java.lang.CharSequence subject,
                                                           java.lang.CharSequence fbml)
                                         throws FacebookException
Deprecated. 

Description copied from interface: IFacebookRestClient
Sends a notification email to the specified users, who must have added your application. You can send five (5) emails to a user per day. Requires a session key for desktop applications, which may only send email to the person whose session it is. This method does not require a session for Web applications.

Specified by:
notifications_sendEmail in interface IFacebookRestClient<T>
Parameters:
recipientIds - up to 100 user ids to which the message is to be sent
subject - the subject of the notification email (optional)
fbml - markup to be sent to the specified users via email; only a stripped-down set of FBML that allows only tags that result in text, links and linebreaks is allowed
Returns:
a comma-separated list of the IDs of the users to whom the email was successfully sent
Throws:
FacebookException
See Also:
Developers Wiki: notifications.sendEmail

notifications_sendEmailPlain

@Deprecated
public java.lang.String notifications_sendEmailPlain(java.util.Collection<java.lang.Long> recipientIds,
                                                                java.lang.CharSequence subject,
                                                                java.lang.CharSequence text)
                                              throws FacebookException
Deprecated. 

Description copied from interface: IFacebookRestClient
Sends a notification email to the specified users, who must have added your application. You can send five (5) emails to a user per day. Requires a session key for desktop applications, which may only send email to the person whose session it is. This method does not require a session for Web applications.

Specified by:
notifications_sendEmailPlain in interface IFacebookRestClient<T>
Parameters:
recipientIds - up to 100 user ids to which the message is to be sent
subject - the subject of the notification email (optional)
text - the plain text to send to the specified users via email
Returns:
a comma-separated list of the IDs of the users to whom the email was successfully sent
Throws:
FacebookException
See Also:
Developers Wiki: notifications.sendEmail

notifications_sendEmailStr

@Deprecated
public java.lang.String notifications_sendEmailStr(java.util.Collection<java.lang.Long> recipientIds,
                                                              java.lang.CharSequence subject,
                                                              java.lang.CharSequence fbml,
                                                              java.lang.CharSequence text)
                                            throws FacebookException
Deprecated. 

Description copied from interface: IFacebookRestClient
Sends a notification email to the specified users, who must have added your application. You can send five (5) emails to a user per day. Requires a session key for desktop applications, which may only send email to the person whose session it is. This method does not require a session for Web applications. Either fbml or text must be specified.

Specified by:
notifications_sendEmailStr in interface IFacebookRestClient<T>
Parameters:
recipientIds - up to 100 user ids to which the message is to be sent
subject - the subject of the notification email (optional)
fbml - markup to be sent to the specified users via email; only a stripped-down set of FBML tags that result in text, links and linebreaks is allowed
text - the plain text to send to the specified users via email
Returns:
a comma-separated list of the IDs of the users to whom the email was successfully sent
Throws:
FacebookException
See Also:
Developers Wiki: notifications.sendEmail

pages_isAdmin

public boolean pages_isAdmin(java.lang.Long pageId)
                      throws FacebookException
Description copied from interface: IFacebookRestClient
Checks whether the logged-in user for this session is an admin of the page with the given pageId.

Specified by:
pages_isAdmin in interface IFacebookRestClient<T>
Parameters:
pageId - the ID of the page
Returns:
true if the logged-in user is an admin
Throws:
FacebookException
See Also:
Developers Wiki: Pages.isAdmin

pages_isAppAdded

public boolean pages_isAppAdded(java.lang.Long pageId)
                         throws FacebookException
Description copied from interface: IFacebookRestClient
Checks whether a page has added the application

Specified by:
pages_isAppAdded in interface IFacebookRestClient<T>
Parameters:
pageId - the ID of the page
Returns:
true if the page has added the application
Throws:
FacebookException
See Also:
Developers Wiki: Pages.isAppAdded

pages_isFan

public boolean pages_isFan(java.lang.Long pageId,
                           java.lang.Long userId)
                    throws FacebookException
Description copied from interface: IFacebookRestClient
Checks whether a user is a fan of the page with the given pageId.

Specified by:
pages_isFan in interface IFacebookRestClient<T>
Parameters:
pageId - the ID of the page
userId - the ID of the user (defaults to the logged-in user if null)
Returns:
true if the user is a fan of the page
Throws:
FacebookException
See Also:
Developers Wiki: Pages.isFan

pages_isFan

public boolean pages_isFan(java.lang.Long pageId)
                    throws FacebookException
Description copied from interface: IFacebookRestClient
Checks whether the logged-in user is a fan of the page with the given pageId.

Specified by:
pages_isFan in interface IFacebookRestClient<T>
Parameters:
pageId - the ID of the page
Returns:
true if the logged-in user is a fan of the page
Throws:
FacebookException
See Also:
Developers Wiki: Pages.isFan

permissions_grantApiAccess

public boolean permissions_grantApiAccess(java.lang.String apiKey,
                                          java.util.Set<FacebookMethod> methods)
                                   throws FacebookException
Description copied from interface: IFacebookRestClient
Grant permission to an external app to make API calls on behalf of the current application.

Specified by:
permissions_grantApiAccess in interface IFacebookRestClient<T>
Parameters:
apiKey - the API-key of the application to grant permission to.
methods - the API methods to allow the other application to call. If the set is empty or null, permission is granted for all API methods.
Returns:
true if the operation succeeds false otherwise
Throws:
FacebookException

permissions_grantFullApiAccess

public boolean permissions_grantFullApiAccess(java.lang.String apiKey)
                                       throws FacebookException
Description copied from interface: IFacebookRestClient
Grant permission to an external app to make API calls on behalf of the current application. Access is granted to the full set of allowed API methods.

Specified by:
permissions_grantFullApiAccess in interface IFacebookRestClient<T>
Parameters:
apiKey - the API-key of the application to grant permission to.
Returns:
true if the operation succeeds false otherwise
Throws:
FacebookException

permissions_revokeApiAccess

public boolean permissions_revokeApiAccess(java.lang.String apiKey)
                                    throws FacebookException
Description copied from interface: IFacebookRestClient
Revokes the specified application's permission to call API methods on behalf of the current app.

Specified by:
permissions_revokeApiAccess in interface IFacebookRestClient<T>
Parameters:
apiKey - the API key of the application to remove permissions for.
Returns:
true if the operation succeeds false otherwise
Throws:
FacebookException

photos_addTag

public boolean photos_addTag(java.lang.String photoId,
                             java.lang.Long taggedUserId,
                             java.lang.Double pct,
                             java.lang.Double pct2)
                      throws FacebookException
Description copied from interface: IFacebookRestClient
Adds a tag to a photo.

Specified by:
photos_addTag in interface IFacebookRestClient<T>
Parameters:
photoId - The photo id of the photo to be tagged.
taggedUserId - The list of photos from which to extract photo tags.
pct - The horizontal position of the tag, as a percentage from 0 to 100, from the left of the photo.
pct2 - The vertical position of the tag, as a percentage from 0 to 100, from the top of the photo.
Returns:
whether the tag was successfully added.
Throws:
FacebookException

photos_addTag

public boolean photos_addTag(java.lang.String photoId,
                             java.lang.CharSequence tagText,
                             java.lang.Double pct,
                             java.lang.Double pct2)
                      throws FacebookException
Description copied from interface: IFacebookRestClient
Adds a tag to a photo.

Specified by:
photos_addTag in interface IFacebookRestClient<T>
Parameters:
photoId - The photo id of the photo to be tagged.
tagText - The text of the tag.
pct - The horizontal position of the tag, as a percentage from 0 to 100, from the left of the photo.
pct2 - The list of photos from which to extract photo tags.
Returns:
whether the tag was successfully added.
Throws:
FacebookException

photos_addTag

public boolean photos_addTag(java.lang.String photoId,
                             java.lang.Long taggedUserId,
                             java.lang.Double pct,
                             java.lang.Double pct2,
                             java.lang.Long userId)
                      throws FacebookException
Description copied from interface: IFacebookRestClient
Adds a tag to a photo.

Specified by:
photos_addTag in interface IFacebookRestClient<T>
Parameters:
photoId - The photo id of the photo to be tagged.
taggedUserId - The list of photos from which to extract photo tags.
pct - The horizontal position of the tag, as a percentage from 0 to 100, from the left of the photo.
pct2 - The vertical position of the tag, as a percentage from 0 to 100, from the top of the photo.
userId - the user tagging the photo.
Returns:
whether the tag was successfully added.
Throws:
FacebookException

photos_addTag

public boolean photos_addTag(java.lang.String photoId,
                             java.lang.CharSequence tagText,
                             java.lang.Double pct,
                             java.lang.Double pct2,
                             java.lang.Long userId)
                      throws FacebookException
Description copied from interface: IFacebookRestClient
Adds a tag to a photo.

Specified by:
photos_addTag in interface IFacebookRestClient<T>
Parameters:
photoId - The photo id of the photo to be tagged.
tagText - The text of the tag.
pct - The horizontal position of the tag, as a percentage from 0 to 100, from the left of the photo.
pct2 - The list of photos from which to extract photo tags.
userId - the user tagging the photo.
Returns:
whether the tag was successfully added.
Throws:
FacebookException

profile_setFBML

@Deprecated
public 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. 

Description copied from interface: IFacebookRestClient
Sets the FBML for a user's profile, including the content for both the profile box and the profile actions.

Specified by:
profile_setFBML in interface IFacebookRestClient<T>
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

profile_setFBML

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

Specified by:
profile_setFBML in interface IFacebookRestClient<T>
Throws:
FacebookException
See Also:
IFacebookRestClient.profile_setFBML(Long, String, String, String, String)

profile_setFBML

@Deprecated
public boolean profile_setFBML(java.lang.CharSequence profileFbmlMarkup,
                                          java.lang.CharSequence profileActionFbmlMarkup)
                        throws FacebookException
Deprecated. 

Description copied from interface: IFacebookRestClient
Sets the FBML for the profile box and profile actions for the logged-in user. Refer to the FBML documentation for a description of the markup and its role in various contexts.

Specified by:
profile_setFBML in interface IFacebookRestClient<T>
Parameters:
profileFbmlMarkup - the FBML for the profile box
profileActionFbmlMarkup - the FBML for the profile actions
Returns:
a boolean indicating whether the FBML was successfully set
Throws:
FacebookException
See Also:
Developers wiki: Profile.setFBML

profile_setFBML

@Deprecated
public boolean profile_setFBML(java.lang.CharSequence profileFbmlMarkup,
                                          java.lang.CharSequence profileActionFbmlMarkup,
                                          java.lang.Long profileId)
                        throws FacebookException
Deprecated. 

Description copied from interface: IFacebookRestClient
Sets the FBML for the profile box and profile actions for the user or page profile with ID profileId. Refer to the FBML documentation for a description of the markup and its role in various contexts.

Specified by:
profile_setFBML in interface IFacebookRestClient<T>
Parameters:
profileFbmlMarkup - the FBML for the profile box
profileActionFbmlMarkup - the FBML for the profile actions
profileId - a page or user ID (null for the logged-in user)
Returns:
a boolean indicating whether the FBML was successfully set
Throws:
FacebookException
See Also:
Developers wiki: Profile.setFBML

profile_setFBML

@Deprecated
public boolean profile_setFBML(java.lang.CharSequence profileFbmlMarkup,
                                          java.lang.CharSequence profileActionFbmlMarkup,
                                          java.lang.CharSequence mobileFbmlMarkup,
                                          java.lang.Long profileId)
                        throws FacebookException
Deprecated. 

Description copied from interface: IFacebookRestClient
Sets the FBML for the profile box, profile actions, and mobile devices for the user or page profile with ID profileId. Refer to the FBML documentation for a description of the markup and its role in various contexts.

Specified by:
profile_setFBML in interface IFacebookRestClient<T>
Parameters:
profileFbmlMarkup - the FBML for the profile box
profileActionFbmlMarkup - the FBML for the profile actions
mobileFbmlMarkup - the FBML for mobile devices
profileId - a page or user ID (null for the logged-in user)
Returns:
a boolean indicating whether the FBML was successfully set
Throws:
FacebookException
See Also:
Developers wiki: Profile.setFBML

profile_setFBML

@Deprecated
public boolean profile_setFBML(java.lang.CharSequence profileFbmlMarkup,
                                          java.lang.CharSequence profileActionFbmlMarkup,
                                          java.lang.CharSequence mobileFbmlMarkup)
                        throws FacebookException
Deprecated. 

Description copied from interface: IFacebookRestClient
Sets the FBML for the profile box, profile actions, and mobile devices for the current user. Refer to the FBML documentation for a description of the markup and its role in various contexts.

Specified by:
profile_setFBML in interface IFacebookRestClient<T>
Parameters:
profileFbmlMarkup - the FBML for the profile box
profileActionFbmlMarkup - the FBML for the profile actions
mobileFbmlMarkup - the FBML for mobile devices
Returns:
a boolean indicating whether the FBML was successfully set
Throws:
FacebookException
See Also:
Developers wiki: Profile.setFBML

profile_setMobileFBML

@Deprecated
public boolean profile_setMobileFBML(java.lang.CharSequence fbmlMarkup)
                              throws FacebookException
Deprecated. 

Description copied from interface: IFacebookRestClient
Sets the FBML for the logged-in user's profile on mobile devices.

Specified by:
profile_setMobileFBML in interface IFacebookRestClient<T>
Parameters:
fbmlMarkup - refer to the FBML documentation for a description of the markup and its role in various contexts
Returns:
a boolean indicating whether the FBML was successfully set
Throws:
FacebookException
See Also:
Developers wiki: Profile.setFBML

profile_setMobileFBML

@Deprecated
public boolean profile_setMobileFBML(java.lang.CharSequence fbmlMarkup,
                                                java.lang.Long profileId)
                              throws FacebookException
Deprecated. 

Description copied from interface: IFacebookRestClient
Sets the FBML for the user or page profile with ID profileId on mobile devices.

Specified by:
profile_setMobileFBML in interface IFacebookRestClient<T>
Parameters:
fbmlMarkup - refer to the FBML documentation for a description of the markup and its role in various contexts
profileId - a page or user ID (null for the logged-in user)
Returns:
a boolean indicating whether the FBML was successfully set
Throws:
FacebookException
See Also:
Developers wiki: Profile.setFBML

profile_setProfileActionFBML

@Deprecated
public boolean profile_setProfileActionFBML(java.lang.CharSequence fbmlMarkup)
                                     throws FacebookException
Deprecated. 

Description copied from interface: IFacebookRestClient
Sets the FBML for profile actions for the logged-in user.

Specified by:
profile_setProfileActionFBML in interface IFacebookRestClient<T>
Parameters:
fbmlMarkup - refer to the FBML documentation for a description of the markup and its role in various contexts
Returns:
a boolean indicating whether the FBML was successfully set
Throws:
FacebookException
See Also:
Developers wiki: Profile.setFBML

profile_setProfileActionFBML

@Deprecated
public boolean profile_setProfileActionFBML(java.lang.CharSequence fbmlMarkup,
                                                       java.lang.Long profileId)
                                     throws FacebookException
Deprecated. 

Description copied from interface: IFacebookRestClient
Sets the FBML for profile actions for the user or page profile with ID profileId.

Specified by:
profile_setProfileActionFBML in interface IFacebookRestClient<T>
Parameters:
fbmlMarkup - refer to the FBML documentation for a description of the markup and its role in various contexts
profileId - a page or user ID (null for the logged-in user)
Returns:
a boolean indicating whether the FBML was successfully set
Throws:
FacebookException
See Also:
Developers wiki: Profile.setFBML

profile_setProfileFBML

@Deprecated
public boolean profile_setProfileFBML(java.lang.CharSequence fbmlMarkup)
                               throws FacebookException
Deprecated. 

Description copied from interface: IFacebookRestClient
Sets the FBML for a profile box on the logged-in user's profile.

Specified by:
profile_setProfileFBML in interface IFacebookRestClient<T>
Parameters:
fbmlMarkup - refer to the FBML documentation for a description of the markup and its role in various contexts
Throws:
FacebookException
See Also:
Developers wiki: Profile.setFbml

profile_setProfileFBML

@Deprecated
public boolean profile_setProfileFBML(java.lang.CharSequence fbmlMarkup,
                                                 java.lang.Long profileId)
                               throws FacebookException
Deprecated. 

Description copied from interface: IFacebookRestClient
Sets the FBML for a profile box on the user or page profile with ID profileId.

Specified by:
profile_setProfileFBML in interface IFacebookRestClient<T>
Parameters:
fbmlMarkup - refer to the FBML documentation for a description of the markup and its role in various contexts
profileId - a page or user ID (null for the logged-in user)
Returns:
a boolean indicating whether the FBML was successfully set
Throws:
FacebookException
See Also:
Developers wiki: Profile.setFbml

sms_canSend

public boolean sms_canSend()
                    throws FacebookException
Description copied from interface: IFacebookRestClient
Check to see if the application is permitted to send SMS messages to the current application user.

Specified by:
sms_canSend in interface IFacebookRestClient<T>
Returns:
true if the application is presently able to send SMS messages to the current user false otherwise
Throws:
FacebookException - if an error happens when executing the API call.

sms_canSend

public boolean sms_canSend(java.lang.Long userId)
                    throws FacebookException
Description copied from interface: IFacebookRestClient
Check to see if the application is permitted to send SMS messages to the specified user.

Specified by:
sms_canSend in interface IFacebookRestClient<T>
Parameters:
userId - the UID of the user to check permissions for
Returns:
true if the application is presently able to send SMS messages to the specified user false otherwise
Throws:
FacebookException - if an error happens when executing the API call.

sms_send

public java.lang.Integer sms_send(java.lang.String message,
                                  java.lang.Integer smsSessionId,
                                  boolean makeNewSession)
                           throws FacebookException
Description copied from interface: IFacebookRestClient
Send an SMS message to the current application user.

Specified by:
sms_send in interface IFacebookRestClient<T>
Parameters:
message - the message to send.
smsSessionId - the SMS session id to use, note that that is distinct from the user's facebook session id. It is used to allow applications to keep track of individual SMS conversations/threads for a single user. Specify null if you do not want/need to use a session for the current message.
makeNewSession - set to true to request that Facebook allocate a new SMS session id for this message. The allocated id will be returned as the result of this API call. You should only set this to true if you are passing a null 'smsSessionId' value. Otherwise you already have a SMS session id, and do not need a new one.
Returns:
an integer specifying the value of the session id alocated by Facebook, if one was requested. If a new session id was not requested, this method will return null.
Throws:
FacebookException - if an error happens when executing the API call.

sms_send

public java.lang.Integer sms_send(java.lang.Long userId,
                                  java.lang.String message,
                                  java.lang.Integer smsSessionId,
                                  boolean makeNewSession)
                           throws FacebookException
Description copied from interface: IFacebookRestClient
Send an SMS message to the specified user.

Specified by:
sms_send in interface IFacebookRestClient<T>
Parameters:
userId - the id of the user to send the message to.
message - the message to send.
smsSessionId - the SMS session id to use, note that that is distinct from the user's facebook session id. It is used to allow applications to keep track of individual SMS conversations/threads for a single user. Specify null if you do not want/need to use a session for the current message.
makeNewSession - set to true to request that Facebook allocate a new SMS session id for this message. The allocated id will be returned as the result of this API call. You should only set this to true if you are passing a null 'smsSessionId' value. Otherwise you already have a SMS session id, and do not need a new one.
Returns:
an integer specifying the value of the session id alocated by Facebook, if one was requested. If a new session id was not requested, this method will return null.
Throws:
FacebookException - if an error happens when executing the API call.

sms_sendMessageWithSession

public int sms_sendMessageWithSession(java.lang.Long userId,
                                      java.lang.CharSequence message)
                               throws FacebookException
Description copied from interface: IFacebookRestClient
Sends a message via SMS to the user identified by userId, with the expectation that the user will reply. The SMS extended permission is required for success. The returned mobile session ID can be stored and used in #sms_sendResponse when the user replies.

Specified by:
sms_sendMessageWithSession in interface IFacebookRestClient<T>
Parameters:
userId - a user ID
message - the message to be sent via SMS
Returns:
a mobile session ID (can be used in #sms_sendResponse)
Throws:
FacebookException - in case of error, e.g. SMS is not enabled
See Also:
FacebookExtendedPerm.SMS, Developers Wiki: Mobile: Application Generated Messages, Developers Wiki: Mobile: Workflow

stream_publish

public java.lang.String stream_publish(java.lang.String message,
                                       Attachment attachment,
                                       java.util.Collection<BundleActionLink> actionLinks,
                                       java.lang.Long targetId,
                                       java.lang.Long userId)
                                throws FacebookException
Specified by:
stream_publish in interface IFacebookRestClient<T>
Throws:
FacebookException

stream_remove

public boolean stream_remove(java.lang.String postId,
                             java.lang.Long userId)
                      throws FacebookException
Specified by:
stream_remove in interface IFacebookRestClient<T>
Throws:
FacebookException

stream_addComment

public java.lang.String stream_addComment(java.lang.String postId,
                                          java.lang.String comment,
                                          java.lang.Long userId)
                                   throws FacebookException
Specified by:
stream_addComment in interface IFacebookRestClient<T>
Throws:
FacebookException

stream_removeComment

public boolean stream_removeComment(java.lang.String commentId,
                                    java.lang.Long userId)
                             throws FacebookException
Specified by:
stream_removeComment in interface IFacebookRestClient<T>
Throws:
FacebookException

stream_addLike

public boolean stream_addLike(java.lang.String postId,
                              java.lang.Long userId)
                       throws FacebookException
Specified by:
stream_addLike in interface IFacebookRestClient<T>
Throws:
FacebookException

stream_removeLike

public boolean stream_removeLike(java.lang.String postId,
                                 java.lang.Long userId)
                          throws FacebookException
Specified by:
stream_removeLike in interface IFacebookRestClient<T>
Throws:
FacebookException

users_clearStatus

public boolean users_clearStatus()
                          throws FacebookException
Description copied from interface: IFacebookRestClient
Clears the logged-in user's Facebook status. Requires the status_update extended permission.

Specified by:
users_clearStatus in interface IFacebookRestClient<T>
Returns:
whether the status was successfully cleared
Throws:
FacebookException
See Also:
IFacebookRestClient.users_hasAppPermission(com.google.code.facebookapi.Permission), FacebookExtendedPerm.STATUS_UPDATE, http://wiki.developers.facebook.com/index.php/Users.setStatus

users_getLoggedInUser

public long users_getLoggedInUser()
                           throws FacebookException
Description copied from interface: IFacebookRestClient
Retrieves the user ID of the user logged in to this API session

Specified by:
users_getLoggedInUser in interface IFacebookRestClient<T>
Returns:
the Facebook user ID of the logged-in user
Throws:
FacebookException

users_hasAppPermission

public boolean users_hasAppPermission(Permission perm)
                               throws FacebookException
Specified by:
users_hasAppPermission in interface IFacebookRestClient<T>
Throws:
FacebookException
See Also:
IFacebookRestClient.users_hasAppPermission(Permission,Long), Users.hasAppPermission

users_hasAppPermission

public boolean users_hasAppPermission(Permission perm,
                                      java.lang.Long userId)
                               throws FacebookException
Description copied from interface: IFacebookRestClient
Checks whether the user has opted in to an extended application permission.

Specified by:
users_hasAppPermission in interface IFacebookRestClient<T>
Parameters:
perm - String identifier for the extended permission that is being checked for. Must be one of email, offline_access, status_update, photo_upload, create_listing, create_event, rsvp_event, sms.
userId - The user ID of the user whose permissions you are checking. 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 ignores this parameter if it is passed by a desktop application.
Returns:
true if the user has granted the application the specified permission false otherwise
Throws:
FacebookException
See Also:
Users.hasAppPermission

users_isAppUser

public boolean users_isAppUser()
                        throws FacebookException
Specified by:
users_isAppUser in interface IFacebookRestClient<T>
Throws:
FacebookException
See Also:
Users.isAppUser, IFacebookRestClient.users_isAppUser(Long)

users_isAppUser

public boolean users_isAppUser(java.lang.Long userId)
                        throws FacebookException
Description copied from interface: IFacebookRestClient
Returns whether the user (either the session user or user specified by uid) has authorized the calling application.

Specified by:
users_isAppUser in interface IFacebookRestClient<T>
Parameters:
userId - The user ID of the user who may have authorized the application. 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 ignores this parameter if it is passed by a desktop application.
Throws:
FacebookException
See Also:
Users.isAppUser

users_setStatus

public boolean users_setStatus(java.lang.String status)
                        throws FacebookException
Description copied from interface: IFacebookRestClient
Sets the logged-in user's Facebook status. Requires the status_update extended permission.

Specified by:
users_setStatus in interface IFacebookRestClient<T>
Returns:
whether the status was successfully set
Throws:
FacebookException
See Also:
IFacebookRestClient.users_hasAppPermission(com.google.code.facebookapi.Permission), FacebookExtendedPerm.STATUS_UPDATE, http://wiki.developers.facebook.com/index.php/Users.setStatus

users_setStatus

public boolean users_setStatus(java.lang.String status,
                               java.lang.Long userId)
                        throws FacebookException
Description copied from interface: IFacebookRestClient
Sets the spedified user's Facebook status. Requires the status_update extended permission.

Specified by:
users_setStatus in interface IFacebookRestClient<T>
Returns:
whether the status was successfully set
Throws:
FacebookException
See Also:
IFacebookRestClient.users_hasAppPermission(com.google.code.facebookapi.Permission), FacebookExtendedPerm.STATUS_UPDATE, http://wiki.developers.facebook.com/index.php/Users.setStatus

users_setStatus

public boolean users_setStatus(java.lang.String newStatus,
                               boolean clear)
                        throws FacebookException
Description copied from interface: IFacebookRestClient
Set the user's profile status message. This requires that the user has granted the application the 'status_update' permission, otherwise the call will return an error. You can use 'users_hasAppPermission' to check to see if the user has granted your app the abbility to update their status.

Specified by:
users_setStatus in interface IFacebookRestClient<T>
Parameters:
newStatus - the new status message to set.
clear - whether or not to clear the old status message.
Returns:
true if the call succeeds false otherwise
Throws:
FacebookException - if an error happens when executing the API call.
See Also:
http://wiki.developers.facebook.com/index.php/Users.setStatus

users_setStatus

public boolean users_setStatus(java.lang.String newStatus,
                               boolean clear,
                               java.lang.Long userId)
                        throws FacebookException
Description copied from interface: IFacebookRestClient
Set the user's profile status message. This requires that the user has granted the application the 'status_update' permission, otherwise the call will return an error. You can use 'users_hasAppPermission' to check to see if the user has granted your app the abbility to update their status.

Specified by:
users_setStatus in interface IFacebookRestClient<T>
Parameters:
newStatus - the new status message to set.
clear - whether or not to clear the old status message.
userId - the id of the user to set the status for.
Returns:
true if the call succeeds false otherwise
Throws:
FacebookException - if an error happens when executing the API call.
See Also:
http://wiki.developers.facebook.com/index.php/Users.setStatus

users_setStatus

public boolean users_setStatus(java.lang.String newStatus,
                               boolean clear,
                               boolean statusIncludesVerb)
                        throws FacebookException
Description copied from interface: IFacebookRestClient
Set the user's profile status message. This requires that the user has granted the application the 'status_update' permission, otherwise the call will return an error. You can use 'users_hasAppPermission' to check to see if the user has granted your app the abbility to update their status

Specified by:
users_setStatus in interface IFacebookRestClient<T>
Parameters:
newStatus - the new status message to set.
clear - whether or not to clear the old status message.
statusIncludesVerb - set to true if you do not want the Facebook Platform to automatically prepend "is " to your status message set to false if you want the "is " prepended (default behavior)
Returns:
true if the call succeeds false otherwise
Throws:
FacebookException - if an error happens when executing the API call.
See Also:
http://wiki.developers.facebook.com/index.php/Users.setStatus

users_setStatus

public boolean users_setStatus(java.lang.String newStatus,
                               boolean clear,
                               boolean statusIncludesVerb,
                               java.lang.Long userId)
                        throws FacebookException
Description copied from interface: IFacebookRestClient
Set the user's profile status message. This requires that the user has granted the application the 'status_update' permission, otherwise the call will return an error. You can use 'users_hasAppPermission' to check to see if the user has granted your app the abbility to update their status

Specified by:
users_setStatus in interface IFacebookRestClient<T>
Parameters:
newStatus - the new status message to set.
clear - whether or not to clear the old status message.
statusIncludesVerb - set to true if you do not want the Facebook Platform to automatically prepend "is " to your status message set to false if you want the "is " prepended (default behavior)
userId - the id of the user to set the status for.
Returns:
true if the call succeeds false otherwise
Throws:
FacebookException - if an error happens when executing the API call.
See Also:
http://wiki.developers.facebook.com/index.php/Users.setStatus

links_post

public java.lang.Long links_post(java.lang.Long userId,
                                 java.lang.String url,
                                 java.lang.String comment)
                          throws FacebookException
Description copied from interface: IFacebookRestClient
Posts a link to the specified user's Wall. The user must have previously given the calling application the "share_item" extended permission.

Specified by:
links_post in interface IFacebookRestClient<T>
Parameters:
userId - the user ID
url - the URL to link to
comment - the user-generated comment about the URL
Returns:
the unique ID of the newly posted link entity
Throws:
FacebookException

intl_uploadNativeStrings

public int intl_uploadNativeStrings(java.util.Map<java.lang.String,java.lang.String> native_strings)
                             throws FacebookException
Description copied from interface: IFacebookRestClient
Lets you insert text strings in their native language into the Facebook Translations database so they can be translated. See Translating Platform Applications for more information about translating your applications.

Specified by:
intl_uploadNativeStrings in interface IFacebookRestClient<T>
Parameters:
native_strings - A Map, from text to be translated, to their description. It will be converted to what facebook expects: A JSON-encoded array of strings to translate. Each element of the string array is an object, with text storing the actual string, description storing the description of the text.
Returns:
If successful, this method returns the number of strings uploaded.
Throws:
FacebookException
See Also:
http://wiki.developers.facebook.com/index.php/Intl.uploadNativeStrings
Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2010. All Rights Reserved.