facebook4j.api

Interface EventMethods

All Known Subinterfaces:

Facebook

All Known Implementing Classes:

FacebookImpl

public interface EventMethods

Author:

Ryuji Yamashita - roundrop at gmail.com

Method Summary

Modifier and Type	Method and Description
java.lang.String	createEvent(EventUpdate eventUpdate) Creates the event for the current user/page.
java.lang.String	createEvent(java.lang.String id, EventUpdate eventUpdate) Creates the event for a user/event/page.
boolean	deleteEvent(java.lang.String eventId) Deletes the event.
boolean	deleteEventPicture(java.lang.String eventId) Deletes the event's profile picture.
boolean	editEvent(java.lang.String eventId, EventUpdate eventUpdate) Updates the event.
Event	getEvent(java.lang.String eventId) Returns a single event.
Event	getEvent(java.lang.String eventId, Reading reading) Returns a single event.
ResponseList<Photo>	getEventPhotos(java.lang.String eventId) Returns the event's photos.
ResponseList<Photo>	getEventPhotos(java.lang.String eventId, Reading reading) Returns the event's photos.
java.net.URL	getEventPictureURL(java.lang.String eventId) Returns url of the event's profile picture.
java.net.URL	getEventPictureURL(java.lang.String eventId, PictureSize size) Returns url of the event's profile picture.
ResponseList<Event>	getEvents() Returns the events the current user/page is attending.
ResponseList<Event>	getEvents(Reading reading) Returns the events the current user/page is attending.
ResponseList<Event>	getEvents(java.lang.String id) Returns the events a user/event/page is attending.
ResponseList<Event>	getEvents(java.lang.String id, Reading reading) Returns the events a user/event/page is attending.
ResponseList<Video>	getEventVideos(java.lang.String eventId) Returns the event's videos.
ResponseList<Video>	getEventVideos(java.lang.String eventId, Reading reading) Returns the event's videos.
ResponseList<RSVPStatus>	getRSVPStatusAsInvited(java.lang.String eventId) Returns a list of invitees for the event.
ResponseList<RSVPStatus>	getRSVPStatusAsInvited(java.lang.String eventId, java.lang.String userId) Checks a specific user has been invited to the event.
ResponseList<RSVPStatus>	getRSVPStatusAsNoreply(java.lang.String eventId) Returns a list of all users who have not replied to the event.
ResponseList<RSVPStatus>	getRSVPStatusAsNoreply(java.lang.String eventId, java.lang.String userId) Returns a single user who have not replied to the event.
ResponseList<RSVPStatus>	getRSVPStatusInAttending(java.lang.String eventId) Returns a list of all users who responded 'yes' to the event.
ResponseList<RSVPStatus>	getRSVPStatusInAttending(java.lang.String eventId, java.lang.String userId) Checks a specific user responded 'yes' to the event.
ResponseList<RSVPStatus>	getRSVPStatusInDeclined(java.lang.String eventId) Returns a list of all users who responded 'no' to the event.
ResponseList<RSVPStatus>	getRSVPStatusInDeclined(java.lang.String eventId, java.lang.String userId) Checks a specific user responded 'no' to the event.
ResponseList<RSVPStatus>	getRSVPStatusInMaybe(java.lang.String eventId) Returns a list of all users who responded 'maybe' to the event.
ResponseList<RSVPStatus>	getRSVPStatusInMaybe(java.lang.String eventId, java.lang.String userId) Checks a specific user responded 'maybe' to the event.
boolean	inviteToEvent(java.lang.String eventId, java.lang.String userId) Invites a user to the event.
boolean	inviteToEvent(java.lang.String eventId, java.lang.String[] userIds) Invites users to the event.
java.lang.String	postEventLink(java.lang.String eventId, java.net.URL link) Posts the link on a event's wall.
java.lang.String	postEventLink(java.lang.String eventId, java.net.URL link, java.lang.String message) Posts the link on a event's wall.
java.lang.String	postEventPhoto(java.lang.String eventId, Media source) Posts the photo on a event's wall.
java.lang.String	postEventPhoto(java.lang.String eventId, Media source, java.lang.String message) Posts the photo on a event's wall.
java.lang.String	postEventStatusMessage(java.lang.String eventId, java.lang.String message) Posts the status message on a event's wall.
java.lang.String	postEventVideo(java.lang.String eventId, Media source) Posts the video on a event's wall.
java.lang.String	postEventVideo(java.lang.String eventId, Media source, java.lang.String title, java.lang.String description) Posts the video on a event's wall.
boolean	rsvpEventAsAttending(java.lang.String eventId) RSVPs the current user as 'attending' the event.
boolean	rsvpEventAsDeclined(java.lang.String eventId) RSVPs the current user as 'declined' the event.
boolean	rsvpEventAsMaybe(java.lang.String eventId) RSVPs the current user as 'maybe' the event.
boolean	uninviteFromEvent(java.lang.String eventId, java.lang.String userId) Un-invites user from the event.
boolean	updateEventPicture(java.lang.String eventId, Media source) Updates the event's profile picture.

Method Detail

getEvents

ResponseList<Event> getEvents()
                       throws FacebookException

Returns the events the current user/page is attending.

Returns:

events

Throws:

FacebookException - when Facebook service or network is unavailable

See Also:

User - Facebook Developers - Connections - events, Page - Facebook Developers - Connections - events

getEvents

ResponseList<Event> getEvents(Reading reading)
                       throws FacebookException

Returns the events the current user/page is attending.

Parameters:

reading - optional reading parameters. see Graph API#reading - Facebook Developers

Returns:

events

Throws:

FacebookException - when Facebook service or network is unavailable

See Also:

User - Facebook Developers - Connections - events, Page - Facebook Developers - Connections - events

getEvents

ResponseList<Event> getEvents(java.lang.String id)
                       throws FacebookException

Returns the events a user/event/page is attending.

Parameters:

id - the ID of a user

Returns:

events

Throws:

FacebookException - when Facebook service or network is unavailable

See Also:

User - Facebook Developers - Connections - events, Page - Facebook Developers - Connections - events

getEvents

ResponseList<Event> getEvents(java.lang.String id,
                              Reading reading)
                       throws FacebookException

Returns the events a user/event/page is attending.

Parameters:

id - the ID of a user/page

reading - optional reading parameters. see Graph API#reading - Facebook Developers

Returns:

events

Throws:

FacebookException - when Facebook service or network is unavailable

See Also:

User - Facebook Developers - Connections - events, Page - Facebook Developers - Connections - events

createEvent

java.lang.String createEvent(EventUpdate eventUpdate)
                      throws FacebookException

Creates the event for the current user/page.

Parameters:

eventUpdate -

Returns:

The new event ID

Throws:

FacebookException - when Facebook service or network is unavailable

See Also:

User#events - Facebook Developers, Page#events - Facebook Developers - Connections - events

createEvent

java.lang.String createEvent(java.lang.String id,
                             EventUpdate eventUpdate)
                      throws FacebookException

Creates the event for a user/event/page.

Parameters:

id - the ID of a user/page

eventUpdate - a event to be created

Returns:

The new event ID

Throws:

FacebookException - when Facebook service or network is unavailable

See Also:

User#events - Facebook Developers, Page#events - Facebook Developers - Connections - events

editEvent

boolean editEvent(java.lang.String eventId,
                  EventUpdate eventUpdate)
           throws FacebookException

Updates the event.

Parameters:

eventId - the ID of a event

eventUpdate - the event to be updated

Returns:

true if update is successful

Throws:

FacebookException - when Facebook service or network is unavailable

See Also:

User#events - Facebook Developers, Page#events - Facebook Developers - Connections - events

deleteEvent

boolean deleteEvent(java.lang.String eventId)
             throws FacebookException

Deletes the event.

Parameters:

eventId - the ID of a event

Returns:

true if delete is successful

Throws:

FacebookException - when Facebook service or network is unavailable

See Also:

User#events - Facebook Developers, Page#events - Facebook Developers - Connections - events

getEvent

Event getEvent(java.lang.String eventId)
        throws FacebookException

Returns a single event.

Parameters:

eventId - the ID of a event

Returns:

event

Throws:

FacebookException - when Facebook service or network is unavailable

See Also:

Event - Facebook Developers

getEvent

Event getEvent(java.lang.String eventId,
               Reading reading)
        throws FacebookException

Returns a single event.

Parameters:

eventId - the ID of a event

reading - optional reading parameters. see Graph API#reading - Facebook Developers

Returns:

event

Throws:

FacebookException - when Facebook service or network is unavailable

See Also:

Event - Facebook Developers

postEventLink

java.lang.String postEventLink(java.lang.String eventId,
                               java.net.URL link)
                        throws FacebookException

Posts the link on a event's wall.

Parameters:

eventId - the ID of a event

link - link URL

Returns:

The new link ID

Throws:

FacebookException - when Facebook service or network is unavailable

See Also:

Event#links - Facebook Developers

postEventLink

java.lang.String postEventLink(java.lang.String eventId,
                               java.net.URL link,
                               java.lang.String message)
                        throws FacebookException

Posts the link on a event's wall.

Parameters:

eventId - the ID of a event

link - link URL

message - link message

Returns:

The new link ID

Throws:

FacebookException - when Facebook service or network is unavailable

See Also:

Event#links - Facebook Developers

postEventStatusMessage

java.lang.String postEventStatusMessage(java.lang.String eventId,
                                        java.lang.String message)
                                 throws FacebookException

Posts the status message on a event's wall.

Parameters:

eventId - the ID of a event

message - status message content

Returns:

The new status message ID

Throws:

FacebookException - when Facebook service or network is unavailable

See Also:

Event#statuses - Facebook Developers

getRSVPStatusAsNoreply

ResponseList<RSVPStatus> getRSVPStatusAsNoreply(java.lang.String eventId)
                                         throws FacebookException

Returns a list of all users who have not replied to the event.

Parameters:

eventId - the ID of a event

Returns:

a list of all users who have not replied to the event

Throws:

FacebookException - when Facebook service or network is unavailable

See Also:

Event#noreply - Facebook Developers

getRSVPStatusAsNoreply

ResponseList<RSVPStatus> getRSVPStatusAsNoreply(java.lang.String eventId,
                                                java.lang.String userId)
                                         throws FacebookException

Returns a single user who have not replied to the event.

Parameters:

eventId - the ID of a event

Returns:

a single users who have not replied to the event

Throws:

FacebookException - when Facebook service or network is unavailable

See Also:

Event#noreply - Facebook Developers

getRSVPStatusAsInvited

ResponseList<RSVPStatus> getRSVPStatusAsInvited(java.lang.String eventId)
                                         throws FacebookException

Returns a list of invitees for the event.

Parameters:

eventId - the ID of a event

Returns:

a list of invitees for the event

Throws:

FacebookException - when Facebook service or network is unavailable

See Also:

Event#invited - Facebook Developers

getRSVPStatusAsInvited

ResponseList<RSVPStatus> getRSVPStatusAsInvited(java.lang.String eventId,
                                                java.lang.String userId)
                                         throws FacebookException

Checks a specific user has been invited to the event.

Parameters:

eventId - the ID of a event

userId - the ID of a user

Returns:

the user has been invited to this event

Throws:

FacebookException - when Facebook service or network is unavailable

See Also:

Event#invited - Facebook Developers

inviteToEvent

boolean inviteToEvent(java.lang.String eventId,
                      java.lang.String userId)
               throws FacebookException

Invites a user to the event.

Parameters:

eventId - the ID of a event

userId - the ID of the user

Returns:

true if the invite is successful

Throws:

FacebookException - when Facebook service or network is unavailable

See Also:

Event#invited - Facebook Developers

inviteToEvent

boolean inviteToEvent(java.lang.String eventId,
                      java.lang.String[] userIds)
               throws FacebookException

Invites users to the event.

Parameters:

eventId - the ID of a event

userIds - the IDs of users

Returns:

true if the invite is successful

Throws:

FacebookException - when Facebook service or network is unavailable

See Also:

Event#invited - Facebook Developers

uninviteFromEvent

boolean uninviteFromEvent(java.lang.String eventId,
                          java.lang.String userId)
                   throws FacebookException

Un-invites user from the event.

Parameters:

eventId - the ID of a event

userId - the ID of a user

Returns:

true if the un-invite is successful

Throws:

FacebookException - when Facebook service or network is unavailable

See Also:

Event#invited - Facebook Developers

getRSVPStatusInAttending

ResponseList<RSVPStatus> getRSVPStatusInAttending(java.lang.String eventId)
                                           throws FacebookException

Returns a list of all users who responded 'yes' to the event.

Parameters:

eventId - the ID of a event

Returns:

a list of all users who responded 'yes' to the event

Throws:

FacebookException - when Facebook service or network is unavailable

See Also:

Event#attending - Facebook Developers

getRSVPStatusInAttending

ResponseList<RSVPStatus> getRSVPStatusInAttending(java.lang.String eventId,
                                                  java.lang.String userId)
                                           throws FacebookException

Checks a specific user responded 'yes' to the event.

Parameters:

eventId - the ID of a event

userId - the ID of a user

Returns:

a specific user responded 'yes' to the event

Throws:

FacebookException - when Facebook service or network is unavailable

See Also:

Event#attending - Facebook Developers

rsvpEventAsAttending

boolean rsvpEventAsAttending(java.lang.String eventId)
                      throws FacebookException

RSVPs the current user as 'attending' the event.

Parameters:

eventId - the ID of a event

Returns:

true if the RSVP is successful

Throws:

FacebookException - when Facebook service or network is unavailable

See Also:

Event#attending - Facebook Developers

getRSVPStatusInMaybe

ResponseList<RSVPStatus> getRSVPStatusInMaybe(java.lang.String eventId)
                                       throws FacebookException

Returns a list of all users who responded 'maybe' to the event.

Parameters:

eventId - the ID of a event

Returns:

a list of all users who responded 'maybe' to the event

Throws:

FacebookException - when Facebook service or network is unavailable

See Also:

Event#maybe - Facebook Developers

getRSVPStatusInMaybe

ResponseList<RSVPStatus> getRSVPStatusInMaybe(java.lang.String eventId,
                                              java.lang.String userId)
                                       throws FacebookException

Checks a specific user responded 'maybe' to the event.

Parameters:

eventId - the ID of a event

userId - the ID of a user

Returns:

a specific user responded 'maybe' to the event

Throws:

FacebookException - when Facebook service or network is unavailable

See Also:

Event#maybe - Facebook Developers

rsvpEventAsMaybe

boolean rsvpEventAsMaybe(java.lang.String eventId)
                  throws FacebookException

RSVPs the current user as 'maybe' the event.

Parameters:

eventId - the ID of a event

Returns:

true if the RSVP is successful

Throws:

FacebookException - when Facebook service or network is unavailable

See Also:

Event#maybe - Facebook Developers

getRSVPStatusInDeclined

ResponseList<RSVPStatus> getRSVPStatusInDeclined(java.lang.String eventId)
                                          throws FacebookException

Returns a list of all users who responded 'no' to the event.

Parameters:

eventId - the ID of a event

Returns:

a list of all users who responded 'no' to the event

Throws:

FacebookException - when Facebook service or network is unavailable

See Also:

Event#declined - Facebook Developers

getRSVPStatusInDeclined

ResponseList<RSVPStatus> getRSVPStatusInDeclined(java.lang.String eventId,
                                                 java.lang.String userId)
                                          throws FacebookException

Checks a specific user responded 'no' to the event.

Parameters:

eventId - the ID of a event

userId - the ID of a user

Returns:

a specific user responded 'no' to the event

Throws:

FacebookException - when Facebook service or network is unavailable

See Also:

Event#declined - Facebook Developers

rsvpEventAsDeclined

boolean rsvpEventAsDeclined(java.lang.String eventId)
                     throws FacebookException

RSVPs the current user as 'declined' the event.

Parameters:

eventId - the ID of a event

Returns:

true if the RSVP is successful

Throws:

FacebookException - when Facebook service or network is unavailable

See Also:

Event#declined - Facebook Developers

getEventPictureURL

java.net.URL getEventPictureURL(java.lang.String eventId)
                         throws FacebookException

Returns url of the event's profile picture.

Parameters:

eventId - the ID of a event

Returns:

url

Throws:

FacebookException - when Facebook service or network is unavailable

See Also:

Event#picture - Facebook Developers

getEventPictureURL

java.net.URL getEventPictureURL(java.lang.String eventId,
                                PictureSize size)
                         throws FacebookException

Returns url of the event's profile picture.

Parameters:

eventId - the ID of a event

size - picture size

Returns:

url

Throws:

FacebookException - when Facebook service or network is unavailable

See Also:

Event#picture - Facebook Developers

updateEventPicture

boolean updateEventPicture(java.lang.String eventId,
                           Media source)
                    throws FacebookException

Updates the event's profile picture.

Parameters:

eventId - the ID of a event

source - picture resource

Returns:

true if update is successful

Throws:

FacebookException - when Facebook service or network is unavailable

See Also:

Event#picture - Facebook Developers

deleteEventPicture

boolean deleteEventPicture(java.lang.String eventId)
                    throws FacebookException

Deletes the event's profile picture.

Parameters:

eventId - the ID of a event

Returns:

true if update is successful

Throws:

FacebookException - when Facebook service or network is unavailable

See Also:

Event#picture - Facebook Developers

getEventPhotos

ResponseList<Photo> getEventPhotos(java.lang.String eventId)
                            throws FacebookException

Returns the event's photos.

Parameters:

eventId - the ID of a event

Throws:

FacebookException - when Facebook service or network is unavailable

See Also:

Event#photos - Facebook Developers

getEventPhotos

ResponseList<Photo> getEventPhotos(java.lang.String eventId,
                                   Reading reading)
                            throws FacebookException

Returns the event's photos.

Parameters:

eventId - the ID of a event

reading - optional reading parameters. see Graph API#reading - Facebook Developers

Throws:

FacebookException - when Facebook service or network is unavailable

See Also:

Event#photos - Facebook Developers

postEventPhoto

java.lang.String postEventPhoto(java.lang.String eventId,
                                Media source)
                         throws FacebookException

Posts the photo on a event's wall.

Parameters:

eventId - the ID of a event

source - photo resource

Returns:

The new photo ID

Throws:

FacebookException - when Facebook service or network is unavailable

See Also:

Event#photos - Facebook Developers

postEventPhoto

java.lang.String postEventPhoto(java.lang.String eventId,
                                Media source,
                                java.lang.String message)
                         throws FacebookException

Posts the photo on a event's wall.

Parameters:

eventId - the ID of a event

source - photo resource

message - photo description

Returns:

The new photo ID

Throws:

FacebookException - when Facebook service or network is unavailable

See Also:

Event#photos - Facebook Developers

getEventVideos

ResponseList<Video> getEventVideos(java.lang.String eventId)
                            throws FacebookException

Returns the event's videos.

Parameters:

eventId - the ID of a event

Throws:

FacebookException - when Facebook service or network is unavailable

See Also:

Event#videos - Facebook Developers

getEventVideos

ResponseList<Video> getEventVideos(java.lang.String eventId,
                                   Reading reading)
                            throws FacebookException

Returns the event's videos.

Parameters:

eventId - the ID of a event

reading - optional reading parameters. see Graph API#reading - Facebook Developers

Throws:

FacebookException - when Facebook service or network is unavailable

See Also:

Event#videos - Facebook Developers

postEventVideo

java.lang.String postEventVideo(java.lang.String eventId,
                                Media source)
                         throws FacebookException

Posts the video on a event's wall.

Parameters:

eventId - the ID of a event

source - video resource

Returns:

The new video ID

Throws:

FacebookException - when Facebook service or network is unavailable

See Also:

Event#videos - Facebook Developers

postEventVideo

java.lang.String postEventVideo(java.lang.String eventId,
                                Media source,
                                java.lang.String title,
                                java.lang.String description)
                         throws FacebookException

Posts the video on a event's wall.

Parameters:

eventId - the ID of a event

source - video resource

title - video title

description - video description

Returns:

The new video ID

Throws:

FacebookException - when Facebook service or network is unavailable

See Also:

Event#videos - Facebook Developers