ifacebookrestclient.java

FACEBOOK上

   * @return album objects
   * @see <a href="http://wiki.developers.facebook.com/index.php/Photos.getAlbums">
   *      Developers Wiki: Photos.getAlbums</a>
   */
  public T photos_getAlbums(Integer userId, Collection<Long> albumIds)
    throws FacebookException, IOException;

  /**
   * Retrieves album metadata for albums owned by a user.
   * @param userId   (optional) the id of the albums' owner (optional)
   * @return album objects
   * @see <a href="http://wiki.developers.facebook.com/index.php/Photos.getAlbums">
   *      Developers Wiki: Photos.getAlbums</a>
   */
  public T photos_getAlbums(Integer userId)
    throws FacebookException, IOException;

  /**
   * Retrieves album metadata for a list of album IDs.
   * @param albumIds the ids of albums whose metadata is to be retrieved
   * @return album objects
   * @see <a href="http://wiki.developers.facebook.com/index.php/Photos.getAlbums">
   *      Developers Wiki: Photos.getAlbums</a>
   */
  public T photos_getAlbums(Collection<Long> albumIds)
    throws FacebookException, IOException;

  /**
   * Retrieves the tags for the given set of photos.
   * @param photoIds The list of photos from which to extract photo tags.
   * @return the created album
   */
  public T photos_getTags(Collection<Long> photoIds)
    throws FacebookException, IOException;

  /**
   * Creates an album.
   * @param albumName The list of photos from which to extract photo tags.
   * @return the created album
   */
  public T photos_createAlbum(String albumName)
    throws FacebookException, IOException;

  /**
   * Creates an album.
   * @param name The album name.
   * @param location The album location (optional).
   * @param description The album description (optional).
   * @return an array of photo objects.
   */
  public T photos_createAlbum(String name, String description, String location)
    throws FacebookException, IOException;

  /**
   * Adds several tags to a photo.
   * @param photoId The photo id of the photo to be tagged.
   * @param tags A list of PhotoTags.
   * @return a list of booleans indicating whether the tag was successfully added.
   */
  public T photos_addTags(Long photoId, Collection<PhotoTag> tags)
    throws FacebookException, IOException;

  /**
   * Adds a tag to a photo.
   * @param photoId The photo id of the photo to be tagged.
   * @param xPct The horizontal position of the tag, as a percentage from 0 to 100, from the left of the photo.
   * @param yPct The vertical position of the tag, as a percentage from 0 to 100, from the top of the photo.
   * @param taggedUserId The list of photos from which to extract photo tags.
   * @return whether the tag was successfully added.
   */
  public boolean photos_addTag(Long photoId, Integer taggedUserId, Double xPct, Double yPct)
    throws FacebookException, IOException;

  /**
   * Adds a tag to a photo.
   * @param photoId The photo id of the photo to be tagged.
   * @param xPct The horizontal position of the tag, as a percentage from 0 to 100, from the left of the photo.
   * @param yPct The list of photos from which to extract photo tags.
   * @param tagText The text of the tag.
   * @return whether the tag was successfully added.
   */
  public boolean photos_addTag(Long photoId, CharSequence tagText, Double xPct, Double yPct)
    throws FacebookException, IOException;

  /**
   * Uploads a photo to Facebook.
   * @param photo an image file
   * @return a T with the standard Facebook photo information
   * @see <a href="http://wiki.developers.facebook.com/index.php/Photos.upload">
   * Developers wiki: Photos.upload</a>
   */
  public T photos_upload(File photo)
    throws FacebookException, IOException;

  /**
   * Uploads a photo to Facebook.
   * @param photo an image file
   * @param caption a description of the image contents
   * @return a T with the standard Facebook photo information
   * @see <a href="http://wiki.developers.facebook.com/index.php/Photos.upload">
   * Developers wiki: Photos.upload</a>
   */
  public T photos_upload(File photo, String caption)
    throws FacebookException, IOException;

  /**
   * Uploads a photo to Facebook.
   * @param photo an image file
   * @param albumId the album into which the photo should be uploaded
   * @return a T with the standard Facebook photo information
   * @see <a href="http://wiki.developers.facebook.com/index.php/Photos.upload">
   * Developers wiki: Photos.upload</a>
   */
  public T photos_upload(File photo, Long albumId)
    throws FacebookException, IOException;

  /**
   * Uploads a photo to Facebook.
   * @param photo an image file
   * @param caption a description of the image contents
   * @param albumId the album into which the photo should be uploaded
   * @return a T with the standard Facebook photo information
   * @see <a href="http://wiki.developers.facebook.com/index.php/Photos.upload">
   * Developers wiki: Photos.upload</a>
   */
  public T photos_upload(File photo, String caption, Long albumId)
    throws FacebookException, IOException;

  /**
   * Retrieves the groups associated with a user
   * @param userId Optional: User associated with groups.
   * A null parameter will default to the session user.
   * @param groupIds Optional: group ids to query.
   * A null parameter will get all groups for the user.
   * @return array of groups
   */
  public T groups_get(Integer userId, Collection<Long> groupIds)
    throws FacebookException, IOException;

  /**
   * Retrieves the membership list of a group
   * @param groupId the group id
   * @return a T containing four membership lists of
   * 'members', 'admins', 'officers', and 'not_replied'
   */
  public T groups_getMembers(Number groupId)
    throws FacebookException, IOException;

  /**
   * Retrieves the results of a Facebook Query Language query
   * @param query : the FQL query statement
   * @return varies depending on the FQL query
   */
  public T fql_query(CharSequence query)
    throws FacebookException, IOException;

  /**
   * Retrieves the outstanding notifications for the session user.
   * @return a T containing
   * notification count pairs for 'messages', 'pokes' and 'shares',
   * a uid list of 'friend_requests', a gid list of 'group_invites',
   * and an eid list of 'event_invites'
   */
  public T notifications_get()
    throws FacebookException, IOException;

  /**
   * Send a notification message to the specified users on behalf of the logged-in user.
   *
   * @param recipientIds the user ids to which the message is to be sent. if empty,
   *        notification will be sent to logged-in user.
   * @param 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
   * @return a URL, possibly null, to which the user should be redirected to finalize
   * the sending of the email
   * @see <a href="http://wiki.developers.facebook.com/index.php/Notifications.send">
   *      Developers Wiki: notifications.send</a>
   */
  public void notifications_send(Collection<Integer> recipientIds, CharSequence notification)
    throws FacebookException, IOException;

  /**
   * Send a notification message to the logged-in user.
   *
   * @param 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
   * @return a URL, possibly null, to which the user should be redirected to finalize
   * the sending of the email
   * @see <a href="http://wiki.developers.facebook.com/index.php/Notifications.send">
   *      Developers Wiki: notifications.send</a>
   */
  public void notifications_send(CharSequence notification)
    throws FacebookException, IOException;

  /**
   * 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 <code>fbml</code> or <code>text</code> must be specified.
   * 
   * @param recipientIds up to 100 user ids to which the message is to be sent
   * @param subject the subject of the notification email (optional)
   * @param 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
   * @param text the plain text to send to the specified users via email
   * @return a comma-separated list of the IDs of the users to whom the email was successfully sent 
   * @see <a href="http://wiki.developers.facebook.com/index.php/Notifications.sendEmail">
   *      Developers Wiki: notifications.sendEmail</a>
   */
  public String notifications_sendEmail(Collection<Integer> recipientIds, CharSequence subject, CharSequence fbml, CharSequence text)
    throws FacebookException, IOException;

  /**
   * 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.
   *
   * @param recipientIds up to 100 user ids to which the message is to be sent
   * @param subject the subject of the notification email (optional)
   * @param 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
   * @return a comma-separated list of the IDs of the users to whom the email was successfully sent
   * @see <a href="http://wiki.developers.facebook.com/index.php/Notifications.send">
   *      Developers Wiki: notifications.sendEmail</a>
   */
  public String notifications_sendEmail(Collection<Integer> recipientIds, CharSequence subject, CharSequence fbml)
    throws FacebookException, IOException;
  
  /**
   * 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.
   *
   * @param recipientIds up to 100 user ids to which the message is to be sent
   * @param subject the subject of the notification email (optional)
   * @param text the plain text to send to the specified users via email
   * @return a comma-separated list of the IDs of the users to whom the email was successfully sent
   * @see <a href="http://wiki.developers.facebook.com/index.php/Notifications.sendEmail">
   *      Developers Wiki: notifications.sendEmail</a>
   */
  public String notifications_sendEmailPlain(Collection<Integer> recipientIds, CharSequence subject, CharSequence text)
    throws FacebookException, IOException;
  
  /**
   * Determines whether this application can send SMS to the user identified by <code>userId</code>
   * @param userId a user ID
   * @return true if sms can be sent to the user
   * @see FacebookExtendedPerm#SMS
   * @see <a href="http://wiki.developers.facebook.com/index.php/Mobile#Application_generated_messages">
   *      Developers Wiki: Mobile: Application Generated Messages</a>