org.springframework.social.facebook.api

Class PagingParameters

java.lang.Object

org.springframework.social.facebook.api.PagingParameters

All Implemented Interfaces:

Serializable

public class PagingParameters
extends Object
implements Serializable

Carries parameters to describe a paged set of results.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PagingParameters(Integer limit, Integer offset, Long since, Long until) Constructs a PagedListParameters.
PagingParameters(Integer limit, Integer offset, Long since, Long until, String after, String before) Constructs a PagedListParameters.
PagingParameters(Integer limit, Integer offset, Long since, Long until, String after, String before, String pagingToken) Constructs a PagedListParameters.

Method Summary

Methods

Modifier and Type	Method and Description
String	getAfter()
String	getBefore()
Integer	getLimit()
Integer	getOffset()
String	getPagingToken()
Long	getSince()
Long	getUntil()
MultiValueMap<String,String>	toMap()

Methods inherited from class java.lang.Object

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

Constructor Detail

PagingParameters

public PagingParameters(Integer limit,
                Integer offset,
                Long since,
                Long until)

Constructs a PagedListParameters.

Parameters:

limit - The number of items to limit the list to.

offset - The offset into the full result list to start this list at.

since - The beginning timestamp bound for time-sensitive content (e.g., posts, comments, etc).

until - The ending timestamp bound for time-sensitive content (e.g., posts, comments, etc).

PagingParameters

public PagingParameters(Integer limit,
                Integer offset,
                Long since,
                Long until,
                String after,
                String before)

Constructs a PagedListParameters.

Parameters:

limit - The number of items to limit the list to.

offset - The offset into the full result list to start this list at.

since - The beginning timestamp bound for time-sensitive content (e.g., posts, comments, etc).

until - The ending timestamp bound for time-sensitive content (e.g., posts, comments, etc).

after - A cursor token that points to the end of the page being returned.

before - A cursor token that points to the start of the page being returned.

PagingParameters

public PagingParameters(Integer limit,
                Integer offset,
                Long since,
                Long until,
                String after,
                String before,
                String pagingToken)

Constructs a PagedListParameters.

Parameters:

limit - The number of items to limit the list to.

offset - The offset into the full result list to start this list at.

since - The beginning timestamp bound for time-sensitive content (e.g., posts, comments, etc).

until - The ending timestamp bound for time-sensitive content (e.g., posts, comments, etc).

after - A cursor token that points to the end of the page being returned.

before - A cursor token that points to the start of the page being returned.

pagingToken - A page token. This is undocumented by Facebook and its purpose is unclear, but if it's available, it helps prevent the last item in a page of results from appearing as the first item on the next page.

Method Detail

getLimit

public Integer getLimit()

getOffset

public Integer getOffset()

getSince

public Long getSince()

getUntil

public Long getUntil()

getAfter

public String getAfter()

getBefore

public String getBefore()

getPagingToken

public String getPagingToken()

toMap

public MultiValueMap<String,String> toMap()