Reference (Old Docs)
OpenGraphAction
This class is no longer available in the most recent version of the SDK.
A more recent version of this class is available. Check out the latest version.

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 or OpenGraphAction.Factory and not implemented directly.

Implements:GraphObject
Package:model
Instance Methods
getId()

Gets the ID of the action.

public String getId()
Returns
The ID
setId(String)

Sets the ID of the action.

public void setId(String id)
ParameterDescription
idThe ID
getType()

Gets the type of the action, which is a string in the form "mynamespace:mytype".

public String getType()
Returns
The type
setType(String)

Sets the type of the action, which is a string in the form "mynamespace:mytype".

public void setType(String type)
ParameterDescription
typeThe type
getStartTime()

Gets the start time of the action.

public Date getStartTime()
Returns
The start time
setStartTime(Date)

Sets the start time of the action.

public void setStartTime(Date startTime)
ParameterDescription
startTimeThe start time
getEndTime()

Gets the end time of the action.

public Date getEndTime()
Returns
The end time
setEndTime(Date)

Sets the end time of the action.

public void setEndTime(Date endTime)
ParameterDescription
endTimeThe end time
getPublishTime()

Gets the time the action was published, if any.

public Date getPublishTime()
Returns
The publish time
setPublishTime(Date)

Sets the time the action was published.

public void setPublishTime(Date publishTime)
ParameterDescription
publishTimeThe publish time
getCreatedTime()

Gets the time the action was created.

public Date getCreatedTime()
Returns
The creation time
setCreatedTime(Date)

Sets the time the action was created.

public void setCreatedTime(Date createdTime)
ParameterDescription
createdTimeThe creation time
getExpiresTime()

Gets the time the action expires at.

public Date getExpiresTime()
Returns
The expiration time
setExpiresTime(Date)

Sets the time the action expires at.

public void setExpiresTime(Date expiresTime)
ParameterDescription
expiresTimeThe expiration time
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.

public String getRef()
Returns
The ref string
setRef(String)

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

public void setRef(String ref)
ParameterDescription
refThe ref string
getMessage()

Gets the message assoicated with the action.

public String getMessage()
Returns
The message
setMessage(String)

Sets the message associated with the action.

public void setMessage(String message)
ParameterDescription
messageThe message
getPlace()

Gets the place where the action took place.

public GraphPlace getPlace()
Returns
The place
setPlace(GraphPlace)

Sets the place where the action took place.

public void setPlace(GraphPlace place)
ParameterDescription
placeThe place
getTags()

Gets the list of profiles that were tagged in the action.

public GraphObjectList getTags()
Returns
The profiles that were tagged in the action
setTags(List)

Sets the list of profiles that were tagged in the action.

public void setTags(List tags)
ParameterDescription
tagsThe profiles that were tagged in the action
getImage()

Gets the images that were associated with the action.

public List getImage()
Returns
The images
setImage(List)

Sets the images that were associated with the action.

public void setImage(List image)
ParameterDescription
imageThe images
setImageUrls(List)

Sets the images associated with the Open Graph action by specifying their URLs. This is a helper that will create GraphObjects with the correct URLs and populate the property with those objects.

public void setImageUrls(List urls)
ParameterDescription
urlsThe URLs
getFrom()

Gets the from-user associated with the action.

public GraphUser getFrom()
Returns
The user
setFrom(GraphUser)

Sets the from-user associated with the action.

public void setFrom(GraphUser from)
ParameterDescription
fromThe from-user
getLikes()

Gets the 'likes' that have been performed on this action.

public JSONObject getLikes()
Returns
The likes
setLikes(JSONObject)

Sets the 'likes' that have been performed on this action.

public void setLikes(JSONObject likes)
ParameterDescription
likesThe likes
getApplication()

Gets the application that created this action.

public GraphObject getApplication()
Returns
The application
setApplication(GraphObject)

Sets the application that created this action.

public void setApplication(GraphObject application)
ParameterDescription
applicationThe application
getComments()

Gets the comments that have been made on this action.

public JSONObject getComments()
Returns
The comments
setComments(JSONObject)

Sets the comments that have been made on this action.

public void setComments(JSONObject comments)
ParameterDescription
commentsThe comments
getData()

Gets the type-specific data for this action; for instance, any properties referencing Open Graph objects will appear under here.

public GraphObject getData()
Returns
A GraphObject representing the type-specific data
setData(GraphObject)

Sets the type-specific data for this action.

public void setData(GraphObject data)
ParameterDescription
dataA GraphObject representing the type-specific data
getExplicitlyShared()

Gets whether the action has been explicitly shared by the user. See Explicit Sharing for more information.

public boolean getExplicitlyShared()
Returns
True if this action was explicitly shared
setExplicitlyShared(boolean)

Sets whether the action has been explicitly shared by the user. See Explicit Sharing for more information. You should only specify this property if explicit sharing has been enabled for an Open Graph action type.

public void setExplicitlyShared(boolean explicitlyShared)
ParameterDescription
explicitlySharedTrue if this action was explicitly shared