Class Horde_Service_Facebook_Events
Events methods for Horde_Service_Facebook
Copyright 2009-2012 Horde LLC (http://www.horde.org/)
-
Horde_Service_Facebook_Base
-
Horde_Service_Facebook_Events
Methods summary
public
array
&
|
#
get( integer $uid = null, string $eids = null, integer $start_time = null, integer $end_time = null, string $rsvp_status = null )
Returns events according to the filters specified.
Returns events according to the filters specified.
Parameters
- $uid
- <p>User associated with events. A null parameter
will default to the session user.</p>
- $eids
- <p>Filter by these comma-separated event ids. A
null parameter will get all events for the
user.</p>
- $start_time
- <p>Filter with this unix time as lower bound.
A null or zero parameter indicates no lower
bound.</p>
- $end_time
- <p>Filter with this UTC as upper bound. A null
or zero parameter indicates no upper bound.</p>
- $rsvp_status
- <p>Only show events where the given uid has this
rsvp status. This only works if you have
specified a value for $uid. Values are as
in events.getMembers. Null indicates to
ignore rsvp status when filtering.</p>
Returns
array The events matching the query.
|
public
array
&
|
#
getMembers( integer $eid )
Returns membership list data associated with an event.
Returns membership list data associated with an event.
Parameters
Returns
array An assoc array of four membership lists, with keys
'attending', 'unsure', 'declined', and 'not_replied'
|
public
boolean
&
|
#
rsvp( integer $eid, string $rsvp_status )
RSVPs the current user to this event.
RSVPs the current user to this event.
Parameters
- $eid
- event id
- $rsvp_status
- 'attending', 'unsure', or 'declined'
Returns
boolean
|
public
boolean
&
|
#
cancel( integer $eid, string $cancel_message = '' )
Cancels an event. Only works for events where application is the admin.
Cancels an event. Only works for events where application is the admin.
Parameters
- $eid
- event id
- $cancel_message
- <p>(Optional) message to send to members of
the event about why it is cancelled</p>
Returns
boolean
|
public
integer
&
|
#
create( array $event_info )
Creates an event on behalf of the user is there is a session, otherwise on
behalf of app. Successful creation guarantees app will be admin.
Creates an event on behalf of the user is there is a session, otherwise on
behalf of app. Successful creation guarantees app will be admin.
Parameters
- $event_info
- json encoded event information
Returns
integer event id
|
public
boolean
&
|
#
edit( integer $eid, array $event_info )
Edits an existing event. Only works for events where application is admin.
Edits an existing event. Only works for events where application is admin.
Parameters
- $eid
- event id
- $event_info
- json encoded event information
Returns
boolean true if successful
|