org.springframework.social.facebook.api

Interface EventOperations

public interface EventOperations

Defines operations for creating and reading event data as well as RSVP'ing to events on behalf of a user.

Method Summary

Modifier and Type	Method and Description
void	acceptInvitation(String eventId) Accepts an invitation to an event.
void	declineInvitation(String eventId) Declines an invitation to an event.
PagedList<Invitation>	getAttending() Retrieves a list of invitations for events that the authenticated user is attending.
PagedList<Invitation>	getAttending(PagingParameters pagingParams) Retrieves a list of invitations for events that the authenticated user is attending.
PagedList<EventInvitee>	getAttending(String eventId) Retrieves the list of an event's invitees who have accepted the invitation.
PagedList<Invitation>	getCreated() Retrieves a list of invitations for events that the authenticated user has created.
PagedList<Invitation>	getCreated(PagingParameters pagingParams) Retrieves a list of invitations for events that the authenticated user has created.
PagedList<Invitation>	getDeclined() Retrieves a list of invitations for events that the authenticated user has declined.
PagedList<Invitation>	getDeclined(PagingParameters pagingParams) Retrieves a list of invitations for events that the authenticated user has declined.
PagedList<EventInvitee>	getDeclined(String eventId) Retrieves the list of an event's invitees who have declined the invitation.
Event	getEvent(String eventId) Retrieves event data for a specified event.
byte[]	getEventImage(String eventId) Retrieves an event's image as an array of bytes.
byte[]	getEventImage(String eventId, ImageType imageType) Retrieves an event's image as an array of bytes.
PagedList<EventInvitee>	getInvited(String eventId) Retrieves the list of an event's invitees.
PagedList<Invitation>	getMaybeAttending() Retrieves a list of invitations for events that the authenticated user may be attending.
PagedList<Invitation>	getMaybeAttending(PagingParameters pagingParams) Retrieves a list of invitations for events that the authenticated user may be attending.
PagedList<EventInvitee>	getMaybeAttending(String eventId) Retrieves the list of an event's invitees who have indicated that they may attend the event.
PagedList<Invitation>	getNoReplies() Retrieves a list of invitations for events that the authenticated user has not replied.
PagedList<Invitation>	getNoReplies(PagingParameters pagingParams) Retrieves a list of invitations for events that the authenticated user has not replied.
PagedList<EventInvitee>	getNoReplies(String eventId) Retrieves the list of an event's invitees who have not yet RSVP'd.
void	maybeInvitation(String eventId) RSVPs to an event with a maybe.
PagedList<Event>	search(String query) Search for events.
PagedList<Event>	search(String query, PagingParameters pagedListParameters) Search for events.

Method Detail

getEvent

Event getEvent(String eventId)

Retrieves event data for a specified event.

Parameters:

eventId - the event ID

Returns:

an Event object

Throws:

org.springframework.social.ApiException - if there is an error while communicating with Facebook.

getEventImage

byte[] getEventImage(String eventId)

Retrieves an event's image as an array of bytes. Returns the image in Facebook's "normal" type.

Parameters:

eventId - the event ID

Returns:

an array of bytes containing the event's image.

Throws:

org.springframework.social.ApiException - if there is an error while communicating with Facebook.

getEventImage

byte[] getEventImage(String eventId,
                     ImageType imageType)

Retrieves an event's image as an array of bytes.

Parameters:

eventId - the event ID

imageType - the image type (eg., small, normal, large. square)

Returns:

an array of bytes containing the event's image.

Throws:

org.springframework.social.ApiException - if there is an error while communicating with Facebook.

getInvited

PagedList<EventInvitee> getInvited(String eventId)

Retrieves the list of an event's invitees.

Parameters:

eventId - the event ID.

Returns:

a list of EventInvitees for the event.

Throws:

org.springframework.social.ApiException - if there is an error while communicating with Facebook.

getCreated

PagedList<Invitation> getCreated()

Retrieves a list of invitations for events that the authenticated user has created. Requires "user_events" permission.

Returns:

a list of Invitations for events that the user has created.

Throws:

org.springframework.social.InsufficientPermissionException - if the user has not granted "user_events" permission.

org.springframework.social.ApiException - if there is an error while communicating with Facebook.

getCreated

PagedList<Invitation> getCreated(PagingParameters pagingParams)

Retrieves a list of invitations for events that the authenticated user has created. Requires "user_events" permission.

Parameters:

pagingParams - paging parameters

Returns:

a list of Invitations for events that the user has created.

Throws:

org.springframework.social.InsufficientPermissionException - if the user has not granted "user_events" permission.

org.springframework.social.ApiException - if there is an error while communicating with Facebook.

getAttending

PagedList<Invitation> getAttending()

Retrieves a list of invitations for events that the authenticated user is attending. Requires "user_events" permission.

Returns:

a list of Invitations for events that the user is attending.

Throws:

org.springframework.social.InsufficientPermissionException - if the user has not granted "user_events" permission.

org.springframework.social.ApiException - if there is an error while communicating with Facebook.

getAttending

PagedList<Invitation> getAttending(PagingParameters pagingParams)

Retrieves a list of invitations for events that the authenticated user is attending. Requires "user_events" permission.

Parameters:

pagingParams - paging parameters

Returns:

a list of Invitations for events that the user is attending.

Throws:

org.springframework.social.InsufficientPermissionException - if the user has not granted "user_events" permission.

org.springframework.social.ApiException - if there is an error while communicating with Facebook.

getAttending

PagedList<EventInvitee> getAttending(String eventId)

Retrieves the list of an event's invitees who have accepted the invitation.

Parameters:

eventId - the event ID.

Returns:

a list of EventInvitees for the event.

Throws:

org.springframework.social.ApiException - if there is an error while communicating with Facebook.

getMaybeAttending

PagedList<Invitation> getMaybeAttending()

Retrieves a list of invitations for events that the authenticated user may be attending. Requires "user_events" permission.

Returns:

a list of Invitations for events that the user is attending.

Throws:

org.springframework.social.InsufficientPermissionException - if the user has not granted "user_events" permission.

org.springframework.social.ApiException - if there is an error while communicating with Facebook.

getMaybeAttending

PagedList<Invitation> getMaybeAttending(PagingParameters pagingParams)

Retrieves a list of invitations for events that the authenticated user may be attending. Requires "user_events" permission.

Parameters:

pagingParams - paging parameters

Returns:

a list of Invitations for events that the user is attending.

Throws:

org.springframework.social.InsufficientPermissionException - if the user has not granted "user_events" permission.

org.springframework.social.ApiException - if there is an error while communicating with Facebook.

getMaybeAttending

PagedList<EventInvitee> getMaybeAttending(String eventId)

Retrieves the list of an event's invitees who have indicated that they may attend the event.

Parameters:

eventId - the event ID.

Returns:

a list of EventInvitees for the event.

Throws:

org.springframework.social.ApiException - if there is an error while communicating with Facebook.

getNoReplies

PagedList<Invitation> getNoReplies()

Retrieves a list of invitations for events that the authenticated user has not replied. Requires "user_events" permission.

Returns:

a list of Invitations for events that the user has not replied.

Throws:

org.springframework.social.InsufficientPermissionException - if the user has not granted "user_events" permission.

org.springframework.social.ApiException - if there is an error while communicating with Facebook.

getNoReplies

PagedList<Invitation> getNoReplies(PagingParameters pagingParams)

Retrieves a list of invitations for events that the authenticated user has not replied. Requires "user_events" permission.

Parameters:

pagingParams - paging parameters

Returns:

a list of Invitations for events that the user has not replied.

Throws:

org.springframework.social.InsufficientPermissionException - if the user has not granted "user_events" permission.

org.springframework.social.ApiException - if there is an error while communicating with Facebook.

getNoReplies

PagedList<EventInvitee> getNoReplies(String eventId)

Retrieves the list of an event's invitees who have not yet RSVP'd.

Parameters:

eventId - the event ID.

Returns:

a list of EventInvitees for the event.

Throws:

org.springframework.social.ApiException - if there is an error while communicating with Facebook.

getDeclined

PagedList<Invitation> getDeclined()

Retrieves a list of invitations for events that the authenticated user has declined. Requires "user_events" permission.

Returns:

a list of Invitations for events that the user has declined.

Throws:

org.springframework.social.InsufficientPermissionException - if the user has not granted "user_events" permission.

org.springframework.social.ApiException - if there is an error while communicating with Facebook.

getDeclined

PagedList<Invitation> getDeclined(PagingParameters pagingParams)

Retrieves a list of invitations for events that the authenticated user has declined. Requires "user_events" permission.

Parameters:

pagingParams - paging parameters

Returns:

a list of Invitations for events that the user has declined.

Throws:

org.springframework.social.InsufficientPermissionException - if the user has not granted "user_events" permission.

org.springframework.social.ApiException - if there is an error while communicating with Facebook.

getDeclined

PagedList<EventInvitee> getDeclined(String eventId)

Retrieves the list of an event's invitees who have declined the invitation.

Parameters:

eventId - the event ID.

Returns:

a list of EventInvitees for the event.

Throws:

org.springframework.social.ApiException - if there is an error while communicating with Facebook.

acceptInvitation

void acceptInvitation(String eventId)

Accepts an invitation to an event. Requires "rsvp_event" permission.

Parameters:

eventId - the event ID

Throws:

org.springframework.social.ApiException - if there is an error while communicating with Facebook.

org.springframework.social.InsufficientPermissionException - if the user has not granted "rsvp_event" permission.

org.springframework.social.MissingAuthorizationException - if FacebookTemplate was not created with an access token.

maybeInvitation

void maybeInvitation(String eventId)

RSVPs to an event with a maybe. Requires "rsvp_event" permission.

Parameters:

eventId - the event ID

Throws:

org.springframework.social.ApiException - if there is an error while communicating with Facebook.

org.springframework.social.InsufficientPermissionException - if the user has not granted "rsvp_event" permission.

org.springframework.social.MissingAuthorizationException - if FacebookTemplate was not created with an access token.

declineInvitation

void declineInvitation(String eventId)

Declines an invitation to an event. Requires "rsvp_event" permission.

Parameters:

eventId - the event ID

Throws:

org.springframework.social.ApiException - if there is an error while communicating with Facebook.

org.springframework.social.InsufficientPermissionException - if the user has not granted "rsvp_event" permission.

org.springframework.social.MissingAuthorizationException - if FacebookTemplate was not created with an access token.

search

PagedList<Event> search(String query)

Search for events.

Parameters:

query - the search query (e.g., "Spring User Group")

Returns:

a list of Events matching the search query

Throws:

org.springframework.social.ApiException - if there is an error while communicating with Facebook.

search

PagedList<Event> search(String query,
                        PagingParameters pagedListParameters)

Search for events.

Parameters:

query - the search query (e.g., "Spring User Group")

pagedListParameters - the parameters defining the bounds of the list to return.

Returns:

a list of Events matching the search query

Throws:

org.springframework.social.ApiException - if there is an error while communicating with Facebook.