|
Spring Social Facebook | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
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 | |
|---|---|
void |
acceptInvitation(java.lang.String eventId)
Accepts an invitation to an event. |
java.lang.String |
createEvent(java.lang.String name,
java.lang.String startTime,
java.lang.String endTime)
Creates an event. |
void |
declineInvitation(java.lang.String eventId)
Declines an invitation to an event. |
void |
deleteEvent(java.lang.String eventId)
Deletes an event. |
PagedList<EventInvitee> |
getAttending(java.lang.String eventId)
Retrieves the list of an event's invitees who have accepted the invitation. |
PagedList<EventInvitee> |
getDeclined(java.lang.String eventId)
Retrieves the list of an event's invitees who have declined the invitation. |
Event |
getEvent(java.lang.String eventId)
Retrieves event data for a specified event. |
byte[] |
getEventImage(java.lang.String eventId)
Retrieves an event's image as an array of bytes. |
byte[] |
getEventImage(java.lang.String eventId,
ImageType imageType)
Retrieves an event's image as an array of bytes. |
PagedList<Invitation> |
getInvitations()
Retrieves a list of up to 25 events that the authenticated user has been invited to. |
PagedList<Invitation> |
getInvitations(int offset,
int limit)
Deprecated. Use getInvitations(PagingParameters) instead |
PagedList<Invitation> |
getInvitations(PagingParameters pagedListParameters)
Retrieves a list of events that the authenticated user has been invited to. |
PagedList<Invitation> |
getInvitations(java.lang.String userId)
Retrieves a list of events that the specified user has been invited to. |
PagedList<Invitation> |
getInvitations(java.lang.String userId,
int offset,
int limit)
Deprecated. Use getInvitations(String, PagingParameters) instead |
PagedList<Invitation> |
getInvitations(java.lang.String userId,
PagingParameters pagedListParameters)
Retrieves a list of events that the specified user has been invited to. |
PagedList<EventInvitee> |
getInvited(java.lang.String eventId)
Retrieves the list of an event's invitees. |
PagedList<EventInvitee> |
getMaybeAttending(java.lang.String eventId)
Retrieves the list of an event's invitees who have indicated that they may attend the event. |
PagedList<EventInvitee> |
getNoReplies(java.lang.String eventId)
Retrieves the list of an event's invitees who have not yet RSVP'd. |
void |
maybeInvitation(java.lang.String eventId)
RSVPs to an event with a maybe. |
PagedList<Event> |
search(java.lang.String query)
Search for events. |
PagedList<Event> |
search(java.lang.String query,
int offset,
int limit)
Deprecated. Use search(String, PagingParameters) instead. |
PagedList<Event> |
search(java.lang.String query,
PagingParameters pagedListParameters)
Search for events. |
| Method Detail |
|---|
PagedList<Invitation> getInvitations()
Invitations for the user, or an empty list if not available.
org.springframework.social.ApiException - if there is an error while communicating with Facebook.
org.springframework.social.InsufficientPermissionException - if the user has not granted "user_events" or "friends_events" permission.
org.springframework.social.MissingAuthorizationException - if FacebookTemplate was not created with an access token.
@Deprecated
PagedList<Invitation> getInvitations(int offset,
int limit)
getInvitations(PagingParameters) instead
offset - the offset into the list of eventslimit - the maximum number of events to return
Invitations for the user, or an empty list if not available.
org.springframework.social.ApiException - if there is an error while communicating with Facebook.
org.springframework.social.InsufficientPermissionException - if the user has not granted "user_events" or "friends_events" permission.
org.springframework.social.MissingAuthorizationException - if FacebookTemplate was not created with an access token.PagedList<Invitation> getInvitations(PagingParameters pagedListParameters)
pagedListParameters - the parameters defining the bounds of the list to return.
Invitations for the user, or an empty list if not available.
org.springframework.social.ApiException - if there is an error while communicating with Facebook.
org.springframework.social.InsufficientPermissionException - if the user has not granted "user_events" or "friends_events" permission.
org.springframework.social.MissingAuthorizationException - if FacebookTemplate was not created with an access token.PagedList<Invitation> getInvitations(java.lang.String userId)
userId - the user's ID
Invitations for the user, or an empty list if not available.
org.springframework.social.ApiException - if there is an error while communicating with Facebook.
org.springframework.social.InsufficientPermissionException - if the user has not granted "user_events" or "friends_events" permission.
org.springframework.social.MissingAuthorizationException - if FacebookTemplate was not created with an access token.
@Deprecated
PagedList<Invitation> getInvitations(java.lang.String userId,
int offset,
int limit)
getInvitations(String, PagingParameters) instead
userId - the user's IDoffset - the offset into the list of eventslimit - the maximum number of events to return
Invitations for the user, or an empty list if not available.
org.springframework.social.ApiException - if there is an error while communicating with Facebook.
org.springframework.social.InsufficientPermissionException - if the user has not granted "user_events" or "friends_events" permission.
org.springframework.social.MissingAuthorizationException - if FacebookTemplate was not created with an access token.
PagedList<Invitation> getInvitations(java.lang.String userId,
PagingParameters pagedListParameters)
userId - the user's IDpagedListParameters - the parameters defining the bounds of the list to return.
Invitations for the user, or an empty list if not available.
org.springframework.social.ApiException - if there is an error while communicating with Facebook.
org.springframework.social.InsufficientPermissionException - if the user has not granted "user_events" or "friends_events" permission.
org.springframework.social.MissingAuthorizationException - if FacebookTemplate was not created with an access token.Event getEvent(java.lang.String eventId)
eventId - the event ID
Event object
org.springframework.social.ApiException - if there is an error while communicating with Facebook.byte[] getEventImage(java.lang.String eventId)
eventId - the event ID
org.springframework.social.ApiException - if there is an error while communicating with Facebook.
byte[] getEventImage(java.lang.String eventId,
ImageType imageType)
eventId - the event IDimageType - the image type (eg., small, normal, large. square)
org.springframework.social.ApiException - if there is an error while communicating with Facebook.
java.lang.String createEvent(java.lang.String name,
java.lang.String startTime,
java.lang.String endTime)
name - the name of the eventstartTime - the start time of the event.endTime - the end time of the event.
org.springframework.social.ApiException - if there is an error while communicating with Facebook.
org.springframework.social.InsufficientPermissionException - if the user has not granted "create_event" permission.
org.springframework.social.MissingAuthorizationException - if FacebookTemplate was not created with an access token.void deleteEvent(java.lang.String eventId)
eventId - the ID of the event
org.springframework.social.ApiException - if there is an error while communicating with Facebook.
org.springframework.social.InsufficientPermissionException - if the user has not granted "create_event" permission.
org.springframework.social.MissingAuthorizationException - if FacebookTemplate was not created with an access token.PagedList<EventInvitee> getInvited(java.lang.String eventId)
eventId - the event ID.
EventInvitees for the event.
org.springframework.social.ApiException - if there is an error while communicating with Facebook.PagedList<EventInvitee> getAttending(java.lang.String eventId)
eventId - the event ID.
EventInvitees for the event.
org.springframework.social.ApiException - if there is an error while communicating with Facebook.PagedList<EventInvitee> getMaybeAttending(java.lang.String eventId)
eventId - the event ID.
EventInvitees for the event.
org.springframework.social.ApiException - if there is an error while communicating with Facebook.PagedList<EventInvitee> getNoReplies(java.lang.String eventId)
eventId - the event ID.
EventInvitees for the event.
org.springframework.social.ApiException - if there is an error while communicating with Facebook.PagedList<EventInvitee> getDeclined(java.lang.String eventId)
eventId - the event ID.
EventInvitees for the event.
org.springframework.social.ApiException - if there is an error while communicating with Facebook.void acceptInvitation(java.lang.String eventId)
eventId - the event ID
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.void maybeInvitation(java.lang.String eventId)
eventId - the event ID
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.void declineInvitation(java.lang.String eventId)
eventId - the event ID
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.PagedList<Event> search(java.lang.String query)
query - the search query (e.g., "Spring User Group")
Events matching the search query
org.springframework.social.ApiException - if there is an error while communicating with Facebook.
@Deprecated
PagedList<Event> search(java.lang.String query,
int offset,
int limit)
search(String, PagingParameters) instead.
query - the search query (e.g., "Spring User Group")offset - the offset into the list of eventslimit - the maximum number of events to return
Events matching the search query
org.springframework.social.ApiException - if there is an error while communicating with Facebook.
PagedList<Event> search(java.lang.String query,
PagingParameters pagedListParameters)
query - the search query (e.g., "Spring User Group")pagedListParameters - the parameters defining the bounds of the list to return.
Events matching the search query
org.springframework.social.ApiException - if there is an error while communicating with Facebook.
|
Spring Social Facebook | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||