Class JFacebookEvent

Description
Description | Vars | Methods (details)

Facebook API User class for the Joomla Platform.

Located in /libraries/joomla/facebook/event.php (line 22) 

JFacebookObject
   |
   --JFacebookEvent
Method Summary
Description | Vars | Methods (details)
boolean createAttending (string $event)
boolean createDeclined (string $event)
boolean createInvite (string $event, string $users)
mixed createLink (string $event, string $link, [string $message = null])
boolean createMaybe (string $event)
mixed createPhoto (string $event, string $source, [string $message = null])
mixed createPost (string $event, [string $message = null], [string $link = null], [string $picture = null], [string $name = null], [string $caption = null], [string $description = null], [array $actions = null])
mixed createStatus (string $event, string $message)
mixed createVideo (string $event, string $source, [string $title = null], [string $description = null])
boolean deleteInvite (string $event, string $user)
boolean deleteLink (mixed $link)
boolean deletePost (string $post)
boolean deleteStatus (string $status)
mixed getAttending (string $event, [integer $limit = 0], [integer $offset = 0])
mixed getDeclined (string $event, [integer $limit = 0], [integer $offset = 0])
mixed getEvent (string $event)
mixed getFeed (string $event, [integer $limit = 0], [integer $offset = 0], [string $until = null], [string $since = null])
mixed getInvited (string $event, [integer $limit = 0], [integer $offset = 0])
mixed getMaybe (string $event, [integer $limit = 0], [integer $offset = 0])
mixed getNoreply (string $event, [integer $limit = 0], [integer $offset = 0])
mixed getPhotos (string $event, [integer $limit = 0], [integer $offset = 0], [string $until = null], [string $since = null])
string getPicture (string $event, [boolean $redirect = true], [string $type = null])
mixed getVideos (string $event, [integer $limit = 0], [integer $offset = 0], [string $until = null], [string $since = null])
array isAttending (string $event, mixed $user)
array isDeclined (string $event, mixed $user)
array isInvited (string $event, mixed $user)
array isMaybe (string $event, mixed $user)
array isNoreply (string $event, mixed $user)
Variables
Description | Vars (details) | Methods (details)

Inherited Variables

Inherited from JFacebookObject

JFacebookObject::$client
 JFacebookObject::$oauth
 JFacebookObject::$options
Methods
Description | Vars Methods (details)
createAttending (line 278)

Method to set the current user as attending. Requires authentication and rsvp_event permission.

  • return: Returns true if successful, and false otherwise.
  • since: 13.1
  • access: public
boolean createAttending (string $event)
  • string $event: The event id.
createDeclined (line 368)

Method to set the current user as declined. Requires authentication and rscp_event permission.

  • return: Returns true if successful, and false otherwise.
  • since: 13.1
  • access: public
boolean createDeclined (string $event)
  • string $event: The event id.
createInvite (line 213)

Method to invite users to the event. Requires authentication and create_event permission.

  • return: Returns true if successful, and false otherwise.
  • since: 13.1
  • access: public
boolean createInvite (string $event, string $users)
  • string $event: The event id.
  • string $users: Comma separated list of user ids.
createLink (line 67)

Method to post a link on event's feed which the current_user is or maybe attending. Requires authentication and publish_stream permission.

  • return: The decoded JSON response or false if the client is not authenticated.
  • since: 13.1
  • access: public
mixed createLink (string $event, string $link, [string $message = null])
  • string $event: The event id.
  • string $link: Link URL.
  • string $message: Link message.
createMaybe (line 323)

Method to set the current user as maybe attending. Requires authentication and rscp_event permission.

  • return: Returns true if successful, and false otherwise.
  • since: 13.1
  • access: public
boolean createMaybe (string $event)
  • string $event: The event id.
createPhoto (line 461)

Method to post a photo on event's wall. Requires authentication and publish_stream permission.

  • return: The decoded JSON response or false if the client is not authenticated.
  • since: 13.1
  • access: public
mixed createPhoto (string $event, string $source, [string $message = null])
  • string $event: The event id.
  • string $source: Path to photo.
  • string $message: Photo description.
createPost (line 107)

Method to post on event's wall. Message or link parameter is required. Requires authentication and publish_stream permission.

  • return: The decoded JSON response or false if the client is not authenticated.
  • since: 13.1
  • access: public
mixed createPost (string $event, [string $message = null], [string $link = null], [string $picture = null], [string $name = null], [string $caption = null], [string $description = null], [array $actions = null])
  • string $event: The event id.
  • string $message: Post message.
  • string $link: Post URL.
  • string $picture: Post thumbnail image (can only be used if link is specified)
  • string $name: Post name (can only be used if link is specified).
  • string $caption: Post caption (can only be used if link is specified).
  • string $description: Post description (can only be used if link is specified).
  • array $actions: Post actions array of objects containing name and link.
createStatus (line 148)

Method to post a status message on behalf of the user on the event's wall. Requires authentication and publish_stream permission.

  • return: The decoded JSON response or false if the client is not authenticated.
  • since: 13.1
  • access: public
mixed createStatus (string $event, string $message)
  • string $event: The event id.
  • string $message: Status message content.
createVideo (line 505)

Method to post a video on event's wall. Requires authentication and publish_stream permission.

  • return: The decoded JSON response or false if the client is not authenticated.
  • since: 13.1
  • access: public
mixed createVideo (string $event, string $source, [string $title = null], [string $description = null])
  • string $event: The event id.
  • string $source: Path to photo.
  • string $title: Video title.
  • string $description: Video description.
deleteInvite (line 233)

Method to delete a invitation. Note: you can only delete the invite if the current user is the event admin.

Requires authentication and rsvp_event permission.

  • return: Returns true if successful, and false otherwise.
  • since: 13.1
  • access: public
boolean deleteInvite (string $event, string $user)
  • string $event: The event id.
  • string $user: The user id.
deleteLink (line 86)

Method to delete a link. Requires authentication and publish_stream permission.

  • return: Returns true if successful, and false otherwise.
  • since: 13.1
  • access: public
boolean deleteLink (mixed $link)
  • mixed $link: The Link ID.
deletePost (line 133)

Method to delete a post. Note: you can only delete the post if it was created by the current user.

Requires authentication and publish_stream permission.

  • return: Returns true if successful, and false otherwise.
  • since: 13.1
  • access: public
boolean deletePost (string $post)
  • string $post: The Post ID.
deleteStatus (line 167)

Method to delete a status. Note: you can only delete the post if it was created by the current user.

Requires authentication and publish_stream permission.

  • return: Returns true if successful, and false otherwise.
  • since: 13.1
  • access: public
boolean deleteStatus (string $status)
  • string $status: The Status ID.
getAttending (line 249)

Method to get the list of attending users. Requires authentication and user_events or friends_events permission.

  • return: The decoded JSON response or false if the client is not authenticated.
  • since: 13.1
  • access: public
mixed getAttending (string $event, [integer $limit = 0], [integer $offset = 0])
  • string $event: The event id.
  • integer $limit: The number of objects per page.
  • integer $offset: The object's number on the page.
getDeclined (line 339)

Method to get the list of users which declined the event. Requires authentication and user_events or friends_events permission.

  • return: The decoded JSON response or false if the client is not authenticated.
  • since: 13.1
  • access: public
mixed getDeclined (string $event, [integer $limit = 0], [integer $offset = 0])
  • string $event: The event id.
  • integer $limit: The number of objects per page.
  • integer $offset: The object's number on the page.
getEvent (line 33)

Method to get information about an event visible to the current user. Requires authentication.

  • return: The decoded JSON response or false if the client is not authenticated.
  • since: 13.1
  • access: public
mixed getEvent (string $event)
  • string $event: The event id.
getFeed (line 51)

Method to get the event's wall. Requires authentication.

  • return: The decoded JSON response or false if the client is not authenticated.
  • since: 13.1
  • access: public
mixed getFeed (string $event, [integer $limit = 0], [integer $offset = 0], [string $until = null], [string $since = null])
  • string $event: The event id.
  • integer $limit: The number of objects per page.
  • integer $offset: The object's number on the page.
  • string $until: A unix timestamp or any date accepted by strtotime.
  • string $since: A unix timestamp or any date accepted by strtotime.
getInvited (line 183)

Method to get the list of invitees for the event. Requires authentication and user_events or friends_events permission.

  • return: The decoded JSON response or false if the client is not authenticated.
  • since: 13.1
  • access: public
mixed getInvited (string $event, [integer $limit = 0], [integer $offset = 0])
  • string $event: The event id.
  • integer $limit: The number of objects per page.
  • integer $offset: The object's number on the page.
getMaybe (line 294)

Method to get the list of maybe attending users. Requires authentication and user_events or friends_events permission.

  • return: The decoded JSON response or false if the client is not authenticated.
  • since: 13.1
  • access: public
mixed getMaybe (string $event, [integer $limit = 0], [integer $offset = 0])
  • string $event: The event id.
  • integer $limit: The number of objects per page.
  • integer $offset: The object's number on the page.
getNoreply (line 384)

Method to get the list of users which have not replied to the event. Requires authentication and user_events or friends_events permission.

  • return: The decoded JSON response or false if the client is not authenticated.
  • since: 13.1
  • access: public
mixed getNoreply (string $event, [integer $limit = 0], [integer $offset = 0])
  • string $event: The event id.
  • integer $limit: The number of objects per page.
  • integer $offset: The object's number on the page.
getPhotos (line 445)

Method to get photos published on event's wall. Requires authentication.

  • return: The decoded JSON response or false if the client is not authenticated.
  • since: 13.1
  • access: public
mixed getPhotos (string $event, [integer $limit = 0], [integer $offset = 0], [string $until = null], [string $since = null])
  • string $event: The event id.
  • integer $limit: The number of objects per page.
  • integer $offset: The object's number on the page.
  • string $until: A unix timestamp or any date accepted by strtotime.
  • string $since: A unix timestamp or any date accepted by strtotime.
getPicture (line 415)

Method to get the event's profile picture. Requires authentication and user_events or friends_events permission.

  • return: The URL to the event's profile picture.
  • since: 13.1
  • access: public
string getPicture (string $event, [boolean $redirect = true], [string $type = null])
  • string $event: The event id.
  • boolean $redirect: If false this will return the URL of the picture without a 302 redirect.
  • string $type: To request a different photo use square | small | normal | large.
getVideos (line 488)

Method to get videos published on event's wall. Requires authentication.

  • return: The decoded JSON response or false if the client is not authenticated.
  • since: 13.1
  • access: public
mixed getVideos (string $event, [integer $limit = 0], [integer $offset = 0], [string $until = null], [string $since = null])
  • string $event: The event id.
  • integer $limit: The number of objects per page.
  • integer $offset: The object's number on the page.
  • string $until: A unix timestamp or any date accepted by strtotime.
  • string $since: A unix timestamp or any date accepted by strtotime.
isAttending (line 264)

Method to check if a user is attending an event. Requires authentication and user_events or friends_events permission.

  • return: The decoded JSON response or an empty array if the user is not invited.
  • since: 13.1
  • access: public
array isAttending (string $event, mixed $user)
  • string $event: The event id.
  • mixed $user: Either an integer containing the user ID or a string containing the username.
isDeclined (line 354)

Method to check if a user responded 'no' to the event. Requires authentication and user_events or friends_events permission.

  • return: The decoded JSON response or an empty array if the user is not invited.
  • since: 13.1
  • access: public
array isDeclined (string $event, mixed $user)
  • string $event: The event id.
  • mixed $user: Either an integer containing the user ID or a string containing the username.
isInvited (line 198)

Method to check if a user is invited to the event. Requires authentication and user_events or friends_events permission.

  • return: The decoded JSON response or an empty array if the user is not invited.
  • since: 13.1
  • access: public
array isInvited (string $event, mixed $user)
  • string $event: The event id.
  • mixed $user: Either an integer containing the user ID or a string containing the username.
isMaybe (line 309)

Method to check if a user is maybe attending an event. Requires authentication and user_events or friends_events permission.

  • return: The decoded JSON response or an empty array if the user is not invited.
  • since: 13.1
  • access: public
array isMaybe (string $event, mixed $user)
  • string $event: The event id.
  • mixed $user: Either an integer containing the user ID or a string containing the username.
isNoreply (line 399)

Method to check if a user has not replied to the event. Requires authentication and user_events or friends_events permission.

  • return: The decoded JSON response or an empty array if the user is not invited.
  • since: 13.1
  • access: public
array isNoreply (string $event, mixed $user)
  • string $event: The event id.
  • mixed $user: Either an integer containing the user ID or a string containing the username.

Inherited Methods

Inherited From JFacebookObject

JFacebookObject::__construct()
JFacebookObject::createConnection()
JFacebookObject::deleteConnection()
JFacebookObject::fetchUrl()
JFacebookObject::get()
JFacebookObject::getConnection()
JFacebookObject::getOAuth()
JFacebookObject::sendRequest()
JFacebookObject::setOAuth()

Documentation generated on Tue, 19 Nov 2013 15:02:40 +0100 by phpDocumentor 1.4.3