Source for file note.php
Documentation is available at note.php
* @package Joomla.Platform
* @copyright Copyright (C) 2005 - 2013 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
defined('JPATH_PLATFORM') or die();
* Facebook API Note class for the Joomla Platform.
* @package Joomla.Platform
* @see http://developers.facebook.com/docs/reference/api/note/
* Method to get a note. Requires authentication and user_notes or friends_notes permission for non-public notes.
* @param string $note The note id.
* @return mixed The decoded JSON response or false if the client is not authenticated.
return $this->get($note);
* Method to get a note's comments. Requires authentication and user_notes or friends_notes permission for non-public notes.
* @param string $note The note id.
* @param integer $limit The number of objects per page.
* @param integer $offset The object's number on the page.
* @param string $until A unix timestamp or any date accepted by strtotime.
* @param string $since A unix timestamp or any date accepted by strtotime.
* @return mixed The decoded JSON response or false if the client is not authenticated.
public function getComments($note, $limit =
0, $offset =
0, $until =
null, $since =
null)
return $this->getConnection($note, 'comments', '', $limit, $offset, $until, $since);
* Method to comment on a note. Requires authentication and publish_stream and user_notes or friends_notes permissions.
* @param string $note The note id.
* @param string $message The comment's text.
* @return mixed The decoded JSON response or false if the client is not authenticated.
// Set POST request parameters.
$data['message'] =
$message;
* Method to delete a comment. Requires authentication and publish_stream and user_notes or friends_notes permissions.
* @param string $comment The comment's id.
* @return boolean Returns true if successful, and false otherwise.
* Method to get note's likes. Requires authentication and user_notes or friends_notes for non-public notes.
* @param string $note The note id.
* @param integer $limit The number of objects per page.
* @param integer $offset The object's number on the page.
* @param string $until A unix timestamp or any date accepted by strtotime.
* @param string $since A unix timestamp or any date accepted by strtotime.
* @return mixed The decoded JSON response or false if the client is not authenticated.
public function getLikes($note, $limit =
0, $offset =
0, $until =
null, $since =
null)
return $this->getConnection($note, 'likes', '', $limit, $offset, $until, $since);
* Method to like a note. Requires authentication and publish_stream and user_notes or friends_notes permissions.
* @param string $note The note id.
* @return boolean Returns true if successful, and false otherwise.
* Method to unlike a note. Requires authentication and publish_stream and user_notes or friends_notes permissions.
* @param string $note The note id.
* @return boolean Returns true if successful, and false otherwise.
Documentation generated on Tue, 19 Nov 2013 15:09:35 +0100 by phpDocumentor 1.4.3