com.kakao.friends

Class AppFriendContext

java.lang.Object

com.kakao.auth.common.PageableContext

com.kakao.friends.AppFriendContext

Direct Known Subclasses:

FriendContext

public class AppFriendContext
extends com.kakao.auth.common.PageableContext

Context containing request parameters for Friends API. This class extends PageableContext, which has PageableContext.getAfterUrl() method.

FriendsApi will automatically fill in after url for this context so that subsequent API requests can be made with this url field, overriding all other parameters such as offset, limit and order.

Since:

1.11.1

See Also:

FriendsApi

Constructor Summary

Constructors

Constructor and Description
AppFriendContext(AppFriendOrder friendOrder, int offset, int limit, String order)
AppFriendContext(boolean secureResource, int offset, int limit, String order) 친구의 리스트를 얻어오는데 필요한 데이터 셋을 생성한다.

Method Summary

Modifier and Type	Method and Description
AppFriendOrder	getAppFriendOrder() 친구 리스트 정렬 기준.
int	getLimit() 한 페이지에 가져올 친구의 수, default 100, max 2000
int	getOffset() 가져올 친구 리스트의 시작 offset.
String	getOrder() 친구리스트 정렬방법.
boolean	isSecureResource()

Methods inherited from class com.kakao.auth.common.PageableContext

getAfterUrl, getBeforeUrl, hasNext, setAfterUrl, setBeforeUrl

Methods inherited from class java.lang.Object

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

Constructor Detail

AppFriendContext

public AppFriendContext(AppFriendOrder friendOrder,
                        int offset,
                        int limit,
                        String order)

AppFriendContext

public AppFriendContext(boolean secureResource,
                        int offset,
                        int limit,
                        String order)

친구의 리스트를 얻어오는데 필요한 데이터 셋을 생성한다. 친구의 리스트는 limit 별로 paging 되어서 내려올 수 있기 때문에 생성되는 context에 다음 요청 url 정보를 가지고 있게 되며, next 요청 url 정보는 SDK 에서 응답에 성공할 경우 채워준다.

Parameters:

secureResource - 이미지 url 을 secure url 로 받을 것인지 여부(http/https)

offset - 가져올 친구 리스트의 시작 offset. default 0

limit - 한 페이지에 가져올 친구의 수, default 100, max 2000

order - 친구리스트 정렬방법. asc, desc 중 하나의 오더로 정렬

Method Detail

getAppFriendOrder

public AppFriendOrder getAppFriendOrder()

친구 리스트 정렬 기준.

getLimit

public int getLimit()

한 페이지에 가져올 친구의 수, default 100, max 2000

Overrides:

getLimit in class com.kakao.auth.common.PageableContext

Returns:

한 페이지에 가져올 친구의 수, default 100, max 2000

getOffset

public int getOffset()

가져올 친구 리스트의 시작 offset. default 0

Overrides:

getOffset in class com.kakao.auth.common.PageableContext

Returns:

가져올 친구 리스트의 시작 offset. default 0

getOrder

public String getOrder()

친구리스트 정렬방법. asc, desc 중 하나의 오더로 정렬

Overrides:

getOrder in class com.kakao.auth.common.PageableContext

Returns:

친구리스트 정렬방법. asc, desc 중 하나의 오더로 정렬

isSecureResource

public boolean isSecureResource()