com.facebook.model
Interface OpenGraphAction

All Superinterfaces:
GraphObject

public interface OpenGraphAction
extends GraphObject

Provides a strongly-typed representation of an Open Graph Action. For more documentation of OG Actions, see: https://developers.facebook.com/docs/opengraph/actions/ Note that this interface is intended to be used with GraphObject.Factory and not implemented directly.


Nested Class Summary
 
Nested classes/interfaces inherited from interface com.facebook.model.GraphObject
GraphObject.Factory
 
Method Summary
 GraphObject getApplication()
          Gets the application that created this action.
 JSONObject getComments()
          Gets the comments that have been made on this action.
 Date getCreatedTime()
          Gets the time the action was created.
 Date getEndTime()
          Gets the end time of the action.
 Date getExpiresTime()
          Gets the time the action expires at.
 GraphUser getFrom()
          Gets the from-user associated with the action.
 String getId()
          Gets the ID of the action.
 List<JSONObject> getImage()
          Gets the images that were associated with the action.
 JSONObject getLikes()
          Gets the 'likes' that have been performed on this action.
 String getMessage()
          Gets the message assoicated with the action.
 GraphPlace getPlace()
          Gets the place where the action took place.
 Date getPublishTime()
          Gets the time the action was published, if any.
 String getRef()
          Gets the unique string which will be passed to the OG Action owner's website when a user clicks through this action on Facebook.
 Date getStartTime()
          Gets the start time of the action.
 List<GraphObject> getTags()
          Gets the list of profiles that were tagged in the action.
 void setApplication(GraphObject application)
          Sets the application that created this action.
 void setComments(JSONObject comments)
          Sets the comments that have been made on this action.
 void setCreatedTime(Date createdTime)
          Sets the time the action was created.
 void setEndTime(Date endTime)
          Sets the end time of the action.
 void setExpiresTime(Date expiresTime)
          Sets the time the action expires at.
 void setFrom(GraphUser from)
          Sets the from-user associated with the action.
 void setId(String id)
          Sets the ID of the action.
 void setImage(List<JSONObject> image)
          Sets the images that were associated with the action.
 void setLikes(JSONObject likes)
          Sets the 'likes' that have been performed on this action.
 void setMessage(String message)
          Sets the message associated with the action.
 void setPlace(GraphPlace place)
          Sets the place where the action took place.
 void setPublishTime(Date publishTime)
          Sets the time the action was published.
 void setRef(String ref)
          Sets the unique string which will be passed to the OG Action owner's website when a user clicks through this action on Facebook.
 void setStartTime(Date startTime)
          Sets the start time of the action.
 void setTags(List<? extends GraphObject> tags)
          Sets the list of profiles that were tagged in the action.
 
Methods inherited from interface com.facebook.model.GraphObject
asMap, cast, getInnerJSONObject, getProperty, removeProperty, setProperty
 

Method Detail

getId

String getId()
Gets the ID of the action.

Returns:
the ID

setId

void setId(String id)
Sets the ID of the action.

Parameters:
id - the ID

getStartTime

Date getStartTime()
Gets the start time of the action.

Returns:
the start time

setStartTime

void setStartTime(Date startTime)
Sets the start time of the action.

Parameters:
startTime - the start time

getEndTime

Date getEndTime()
Gets the end time of the action.

Returns:
the end time

setEndTime

void setEndTime(Date endTime)
Sets the end time of the action.

Parameters:
endTime - the end time

getPublishTime

Date getPublishTime()
Gets the time the action was published, if any.

Returns:
the publish time

setPublishTime

void setPublishTime(Date publishTime)
Sets the time the action was published.

Parameters:
publishTime - the publish time

getCreatedTime

Date getCreatedTime()
Gets the time the action was created.

Returns:
the creation time

setCreatedTime

void setCreatedTime(Date createdTime)
Sets the time the action was created.

Parameters:
createdTime - the creation time

getExpiresTime

Date getExpiresTime()
Gets the time the action expires at.

Returns:
the expiration time

setExpiresTime

void setExpiresTime(Date expiresTime)
Sets the time the action expires at.

Parameters:
expiresTime - the expiration time

getRef

String getRef()
Gets the unique string which will be passed to the OG Action owner's website when a user clicks through this action on Facebook.

Returns:
the ref string

setRef

void setRef(String ref)
Sets the unique string which will be passed to the OG Action owner's website when a user clicks through this action on Facebook.

Parameters:
ref - the ref string

getMessage

String getMessage()
Gets the message assoicated with the action.

Returns:
the message

setMessage

void setMessage(String message)
Sets the message associated with the action.

Parameters:
message - the message

getPlace

GraphPlace getPlace()
Gets the place where the action took place.

Returns:
the place

setPlace

void setPlace(GraphPlace place)
Sets the place where the action took place.

Parameters:
place - the place

getTags

List<GraphObject> getTags()
Gets the list of profiles that were tagged in the action.

Returns:
the profiles that were tagged in the action

setTags

void setTags(List<? extends GraphObject> tags)
Sets the list of profiles that were tagged in the action.

Parameters:
tags - the profiles that were tagged in the action

getImage

List<JSONObject> getImage()
Gets the images that were associated with the action.

Returns:
the images

setImage

void setImage(List<JSONObject> image)
Sets the images that were associated with the action.

Parameters:
image - the images

getFrom

GraphUser getFrom()
Gets the from-user associated with the action.

Returns:
the user

setFrom

void setFrom(GraphUser from)
Sets the from-user associated with the action.

Parameters:
from - the from-user

getLikes

JSONObject getLikes()
Gets the 'likes' that have been performed on this action.

Returns:
the likes

setLikes

void setLikes(JSONObject likes)
Sets the 'likes' that have been performed on this action.

Parameters:
likes - the likes

getApplication

GraphObject getApplication()
Gets the application that created this action.

Returns:
the application

setApplication

void setApplication(GraphObject application)
Sets the application that created this action.

Parameters:
application - the application

getComments

JSONObject getComments()
Gets the comments that have been made on this action.

Returns:
the comments

setComments

void setComments(JSONObject comments)
Sets the comments that have been made on this action.

Parameters:
comments - the comments