public
mixed
|
#
getEvent( string $event )
Method to get information about an event visible to the current user.
Requires authentication.
Method to get information about an event visible to the current user.
Requires authentication.
Parameters
- $event
string - $event The event id.
Returns
mixed - The decoded JSON response or false if the client is not authenticated.
Since
13.1
|
public
mixed
|
#
getFeed( string $event, integer $limit = 0, integer $offset = 0, string $until = null, string $since = null )
Method to get the event's wall. Requires authentication.
Method to get the event's wall. Requires authentication.
Parameters
- $event
string - $event The event id.
- $limit
integer - $limit The number of objects per page.
- $offset
integer - $offset The object's number on the page.
- $until
string - $until A unix timestamp or any date accepted by strtotime.
- $since
string - $since A unix timestamp or any date accepted by strtotime.
Returns
mixed - The decoded JSON response or false if the client is not authenticated.
Since
13.1
|
public
mixed
|
#
createLink( string $event, string $link, string $message = null )
Method to post a link on event's feed which the current_user is or maybe
attending. Requires authentication and publish_stream permission.
Method to post a link on event's feed which the current_user is or maybe
attending. Requires authentication and publish_stream permission.
Parameters
- $event
string - $event The event id.
- $link
string - $link Link URL.
- $message
string - $message Link message.
Returns
mixed - The decoded JSON response or false if the client is not authenticated.
Since
13.1
|
public
boolean
|
#
deleteLink( mixed $link )
Method to delete a link. Requires authentication and publish_stream
permission.
Method to delete a link. Requires authentication and publish_stream
permission.
Parameters
- $link
mixed - $link The Link ID.
Returns
boolean - Returns true if successful, and false otherwise.
Since
13.1
|
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 )
Method to post on event's wall. Message or link parameter is required.
Requires authentication and publish_stream permission.
Method to post on event's wall. Message or link parameter is required.
Requires authentication and publish_stream permission.
Parameters
- $event
string - $event The event id.
- $message
string - $message Post message.
- $link
string - $link Post URL.
- $picture
string - $picture Post thumbnail image (can only be used if link is specified)
- $name
string - $name Post name (can only be used if link is specified).
- $caption
string - $caption Post caption (can only be used if link is specified).
- $description
string - $description Post description (can only be used if link is specified).
- $actions
array - $actions Post actions array of objects containing name and link.
Returns
mixed - The decoded JSON response or false if the client is not authenticated.
Since
13.1
|
public
boolean
|
#
deletePost( string $post )
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.
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.
Parameters
- $post
string - $post The Post ID.
Returns
boolean - Returns true if successful, and false otherwise.
Since
13.1
|
public
mixed
|
#
createStatus( string $event, string $message )
Method to post a status message on behalf of the user on the event's wall.
Requires authentication and publish_stream permission.
Method to post a status message on behalf of the user on the event's wall.
Requires authentication and publish_stream permission.
Parameters
- $event
string - $event The event id.
- $message
string - $message Status message content.
Returns
mixed - The decoded JSON response or false if the client is not authenticated.
Since
13.1
|
public
boolean
|
#
deleteStatus( string $status )
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.
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.
Parameters
- $status
string - $status The Status ID.
Returns
boolean - Returns true if successful, and false otherwise.
Since
13.1
|
public
mixed
|
#
getInvited( string $event, integer $limit = 0, integer $offset = 0 )
Method to get the list of invitees for the event. Requires authentication and
user_events or friends_events permission.
Method to get the list of invitees for the event. Requires authentication and
user_events or friends_events permission.
Parameters
- $event
string - $event The event id.
- $limit
integer - $limit The number of objects per page.
- $offset
integer - $offset The object's number on the page.
Returns
mixed - The decoded JSON response or false if the client is not authenticated.
Since
13.1
|
public
array
|
#
isInvited( string $event, mixed $user )
Method to check if a user is invited to the event. Requires authentication
and user_events or friends_events permission.
Method to check if a user is invited to the event. Requires authentication
and user_events or friends_events permission.
Parameters
- $event
string - $event The event id.
- $user
mixed - $user Either an integer containing the user ID or a string containing the
username.
Returns
array - The decoded JSON response or an empty array if the user is not invited.
Since
13.1
|
public
boolean
|
#
createInvite( string $event, string $users )
Method to invite users to the event. Requires authentication and create_event
permission.
Method to invite users to the event. Requires authentication and create_event
permission.
Parameters
- $event
string - $event The event id.
- $users
string - $users Comma separated list of user ids.
Returns
boolean - Returns true if successful, and false otherwise.
Since
13.1
|
public
boolean
|
#
deleteInvite( string $event, string $user )
Method to delete an invitation. Note: you can only delete the invite if the
current user is the event admin. Requires authentication and rsvp_event
permission.
Method to delete an invitation. Note: you can only delete the invite if the
current user is the event admin. Requires authentication and rsvp_event
permission.
Parameters
- $event
string - $event The event id.
- $user
string - $user The user id.
Returns
boolean - Returns true if successful, and false otherwise.
Since
13.1
|
public
mixed
|
#
getAttending( string $event, integer $limit = 0, integer $offset = 0 )
Method to get the list of attending users. Requires authentication and
user_events or friends_events permission.
Method to get the list of attending users. Requires authentication and
user_events or friends_events permission.
Parameters
- $event
string - $event The event id.
- $limit
integer - $limit The number of objects per page.
- $offset
integer - $offset The object's number on the page.
Returns
mixed - The decoded JSON response or false if the client is not authenticated.
Since
13.1
|
public
array
|
#
isAttending( string $event, mixed $user )
Method to check if a user is attending an event. Requires authentication and
user_events or friends_events permission.
Method to check if a user is attending an event. Requires authentication and
user_events or friends_events permission.
Parameters
- $event
string - $event The event id.
- $user
mixed - $user Either an integer containing the user ID or a string containing the
username.
Returns
array - The decoded JSON response or an empty array if the user is not invited.
Since
13.1
|
public
boolean
|
#
createAttending( string $event )
Method to set the current user as attending. Requires authentication and
rsvp_event permission.
Method to set the current user as attending. Requires authentication and
rsvp_event permission.
Parameters
- $event
string - $event The event id.
Returns
boolean - Returns true if successful, and false otherwise.
Since
13.1
|
public
mixed
|
#
getMaybe( string $event, integer $limit = 0, integer $offset = 0 )
Method to get the list of maybe attending users. Requires authentication and
user_events or friends_events permission.
Method to get the list of maybe attending users. Requires authentication and
user_events or friends_events permission.
Parameters
- $event
string - $event The event id.
- $limit
integer - $limit The number of objects per page.
- $offset
integer - $offset The object's number on the page.
Returns
mixed - The decoded JSON response or false if the client is not authenticated.
Since
13.1
|
public
array
|
#
isMaybe( string $event, mixed $user )
Method to check if a user is maybe attending an event. Requires
authentication and user_events or friends_events permission.
Method to check if a user is maybe attending an event. Requires
authentication and user_events or friends_events permission.
Parameters
- $event
string - $event The event id.
- $user
mixed - $user Either an integer containing the user ID or a string containing the
username.
Returns
array - The decoded JSON response or an empty array if the user is not invited.
Since
13.1
|
public
boolean
|
#
createMaybe( string $event )
Method to set the current user as maybe attending. Requires authentication
and rscp_event permission.
Method to set the current user as maybe attending. Requires authentication
and rscp_event permission.
Parameters
- $event
string - $event The event id.
Returns
boolean - Returns true if successful, and false otherwise.
Since
13.1
|
public
mixed
|
#
getDeclined( string $event, integer $limit = 0, integer $offset = 0 )
Method to get the list of users which declined the event. Requires
authentication and user_events or friends_events permission.
Method to get the list of users which declined the event. Requires
authentication and user_events or friends_events permission.
Parameters
- $event
string - $event The event id.
- $limit
integer - $limit The number of objects per page.
- $offset
integer - $offset The object's number on the page.
Returns
mixed - The decoded JSON response or false if the client is not authenticated.
Since
13.1
|
public
array
|
#
isDeclined( string $event, mixed $user )
Method to check if a user responded 'no' to the event. Requires
authentication and user_events or friends_events permission.
Method to check if a user responded 'no' to the event. Requires
authentication and user_events or friends_events permission.
Parameters
- $event
string - $event The event id.
- $user
mixed - $user Either an integer containing the user ID or a string containing the
username.
Returns
array - The decoded JSON response or an empty array if the user is not invited.
Since
13.1
|
public
boolean
|
#
createDeclined( string $event )
Method to set the current user as declined. Requires authentication and
rscp_event permission.
Method to set the current user as declined. Requires authentication and
rscp_event permission.
Parameters
- $event
string - $event The event id.
Returns
boolean - Returns true if successful, and false otherwise.
Since
13.1
|
public
mixed
|
#
getNoreply( string $event, integer $limit = 0, integer $offset = 0 )
Method to get the list of users which have not replied to the event. Requires
authentication and user_events or friends_events permission.
Method to get the list of users which have not replied to the event. Requires
authentication and user_events or friends_events permission.
Parameters
- $event
string - $event The event id.
- $limit
integer - $limit The number of objects per page.
- $offset
integer - $offset The object's number on the page.
Returns
mixed - The decoded JSON response or false if the client is not authenticated.
Since
13.1
|
public
array
|
#
isNoreply( string $event, mixed $user )
Method to check if a user has not replied to the event. Requires
authentication and user_events or friends_events permission.
Method to check if a user has not replied to the event. Requires
authentication and user_events or friends_events permission.
Parameters
- $event
string - $event The event id.
- $user
mixed - $user Either an integer containing the user ID or a string containing the
username.
Returns
array - The decoded JSON response or an empty array if the user is not invited.
Since
13.1
|
public
string
|
#
getPicture( string $event, boolean $redirect = true, string $type = null )
Method to get the event's profile picture. Requires authentication and
user_events or friends_events permission.
Method to get the event's profile picture. Requires authentication and
user_events or friends_events permission.
Parameters
- $event
string - $event The event id.
- $redirect
boolean - $redirect If false this will return the URL of the picture without a 302
redirect.
- $type
string - $type To request a different photo use square | small | normal | large.
Returns
string - The URL to the event's profile picture.
Since
13.1
|
public
mixed
|
#
getPhotos( string $event, integer $limit = 0, integer $offset = 0, string $until = null, string $since = null )
Method to get photos published on event's wall. Requires authentication.
Method to get photos published on event's wall. Requires authentication.
Parameters
- $event
string - $event The event id.
- $limit
integer - $limit The number of objects per page.
- $offset
integer - $offset The object's number on the page.
- $until
string - $until A unix timestamp or any date accepted by strtotime.
- $since
string - $since A unix timestamp or any date accepted by strtotime.
Returns
mixed - The decoded JSON response or false if the client is not authenticated.
Since
13.1
|
public
mixed
|
#
createPhoto( string $event, string $source, string $message = null )
Method to post a photo on event's wall. Requires authentication and
publish_stream permission.
Method to post a photo on event's wall. Requires authentication and
publish_stream permission.
Parameters
- $event
string - $event The event id.
- $source
string - $source Path to photo.
- $message
string - $message Photo description.
Returns
mixed - The decoded JSON response or false if the client is not authenticated.
Since
13.1
|
public
mixed
|
#
getVideos( string $event, integer $limit = 0, integer $offset = 0, string $until = null, string $since = null )
Method to get videos published on event's wall. Requires authentication.
Method to get videos published on event's wall. Requires authentication.
Parameters
- $event
string - $event The event id.
- $limit
integer - $limit The number of objects per page.
- $offset
integer - $offset The object's number on the page.
- $until
string - $until A unix timestamp or any date accepted by strtotime.
- $since
string - $since A unix timestamp or any date accepted by strtotime.
Returns
mixed - The decoded JSON response or false if the client is not authenticated.
Since
13.1
|
public
mixed
|
#
createVideo( string $event, string $source, string $title = null, string $description = null )
Method to post a video on event's wall. Requires authentication and
publish_stream permission.
Method to post a video on event's wall. Requires authentication and
publish_stream permission.
Parameters
- $event
string - $event The event id.
- $source
string - $source Path to photo.
- $title
string - $title Video title.
- $description
string - $description Video description.
Returns
mixed - The decoded JSON response or false if the client is not authenticated.
Since
13.1
|