org.springframework.social.facebook.api

Class PostData

java.lang.Object

org.springframework.social.facebook.api.PostData

public class PostData
extends Object

An object that represents a new post to be created. Offers a builder-like way of creating a new post. Given to FeedOperations.post(PostData).

Constructor Summary

Constructors

Constructor and Description
PostData(String targetFeedId) Creates a new PostData.

Method Summary

Modifier and Type	Method and Description
PostData	allow(String... allow)
PostData	deny(String... deny)
String	getTargetFeedId()
PostData	link(String linkUrl, String picture, String name, String caption, String description)
PostData	message(String message)
PostData	place(String placeId)
PostData	privacy(Post.Privacy privacy)
PostData	tags(String... tags)
MultiValueMap<String,Object>	toRequestParameters()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PostData

public PostData(String targetFeedId)

Creates a new PostData.

Parameters:

targetFeedId - The ID of the owner of the post.

Method Detail

getTargetFeedId

public String getTargetFeedId()

message

public PostData message(String message)

Parameters:

message - A message for the post.

Returns:

the PostData object for additional configuration

link

public PostData link(String linkUrl,
                     String picture,
                     String name,
                     String caption,
                     String description)

Parameters:

linkUrl - A link to include in the post.

picture - A preview image associated with the link. May be null.

name - Overwrites the title of the link preview. May be null.

caption - Overwrites the caption of the link preview. May be null.

description - Overwrites the caption of hte link preview. May be null.

Returns:

the PagePostData object for additional configuration

place

public PostData place(String placeId)

Parameters:

placeId - The ID of a place to associate with the post.

Returns:

the PostData object for additional configuration

tags

public PostData tags(String... tags)

Parameters:

tags - One or more Facebook user IDs to tag in the post. Will be ignored unless a place is specified.

Returns:

the PostData object for additional configuration

privacy

public PostData privacy(Post.Privacy privacy)

Parameters:

privacy - The privacy setting for the post. If CUSTOM, then you must also set at least one of allow() or deny().

Returns:

the PostData object for additional configuration

allow

public PostData allow(String... allow)

Parameters:

allow - One or more Facebook User IDs and friend list IDs that can see the post. Ignored unless privacy is CUSTOM.

Returns:

the PostData object for additional configuration

deny

public PostData deny(String... deny)

Parameters:

deny - One or more Facebook User IDs and friend list IDs that cannot see the post. Ignored unless privacy is CUSTOM.

Returns:

the PostData object for additional configuration

toRequestParameters

public MultiValueMap<String,Object> toRequestParameters()