Package com.vk.api.sdk.queries.friends
Class FriendsGetRequestsQueryWithExtended
- java.lang.Object
-
- com.vk.api.sdk.client.ApiRequest<R>
-
- com.vk.api.sdk.client.AbstractQueryBuilder<FriendsGetRequestsQueryWithExtended,GetRequestsExtendedResponse>
-
- com.vk.api.sdk.queries.friends.FriendsGetRequestsQueryWithExtended
-
public class FriendsGetRequestsQueryWithExtended extends AbstractQueryBuilder<FriendsGetRequestsQueryWithExtended,GetRequestsExtendedResponse>
Query for Friends.getRequests method
-
-
Constructor Summary
Constructors Constructor Description FriendsGetRequestsQueryWithExtended(VkApiClient client, UserActor actor)Creates a AbstractQueryBuilder instance that can be used to build api request with various parameters
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description FriendsGetRequestsQueryWithExtendedcount(java.lang.Integer value)Number of friend requests to return (default 100, maximum 1000).protected java.util.List<java.lang.String>essentialKeys()Get list of required parameter namesprotected FriendsGetRequestsQueryWithExtendedextended(java.lang.Boolean value)'1' — to return response messages from users who have sent a friend request or, if 'suggested' is set to '1', to return a list of suggested friendsFriendsGetRequestsQueryWithExtendedfields(Fields... value)fields Set fieldsFriendsGetRequestsQueryWithExtendedfields(java.util.List<Fields> value)Set fieldsprotected FriendsGetRequestsQueryWithExtendedgetThis()Get reference to this objectFriendsGetRequestsQueryWithExtendedneedMutual(java.lang.Boolean value)'1' — to return a list of mutual friends (up to 20), if anyFriendsGetRequestsQueryWithExtendedneedViewed(java.lang.Boolean value)Set need viewedFriendsGetRequestsQueryWithExtendedoffset(java.lang.Integer value)Offset needed to return a specific subset of friend requests.FriendsGetRequestsQueryWithExtendedout(java.lang.Boolean value)'1' — to return outgoing requests, '0' — to return incoming requests (default)FriendsGetRequestsQueryWithExtendedref(java.lang.String value)Set refFriendsGetRequestsQueryWithExtendedsort(GetRequestsSort value)Sort order: '1' — by number of mutual friends, '0' — by dateFriendsGetRequestsQueryWithExtendedsuggested(java.lang.Boolean value)'1' — to return a list of suggested friends, '0' — to return friend requests (default)-
Methods inherited from class com.vk.api.sdk.client.AbstractQueryBuilder
accessToken, build, captchaKey, captchaSid, clientSecret, confirm, getBody, getMethod, getParams, lang, toString, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, version
-
Methods inherited from class com.vk.api.sdk.client.ApiRequest
execute, executeAsRaw, executeAsString, getClient, getGson, getHeaders, getResponseClass, getUrl, setHeaders
-
-
-
-
Constructor Detail
-
FriendsGetRequestsQueryWithExtended
public FriendsGetRequestsQueryWithExtended(VkApiClient client, UserActor actor)
Creates a AbstractQueryBuilder instance that can be used to build api request with various parameters- Parameters:
client- VK API clientactor- actor with access token
-
-
Method Detail
-
offset
public FriendsGetRequestsQueryWithExtended offset(java.lang.Integer value)
Offset needed to return a specific subset of friend requests.- Parameters:
value- value of "offset" parameter. Minimum is 0.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
count
public FriendsGetRequestsQueryWithExtended count(java.lang.Integer value)
Number of friend requests to return (default 100, maximum 1000).- Parameters:
value- value of "count" parameter. Maximum is 1000. Minimum is 0. By default 100.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
extended
protected FriendsGetRequestsQueryWithExtended extended(java.lang.Boolean value)
'1' — to return response messages from users who have sent a friend request or, if 'suggested' is set to '1', to return a list of suggested friends- Parameters:
value- value of "extended" parameter.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
needMutual
public FriendsGetRequestsQueryWithExtended needMutual(java.lang.Boolean value)
'1' — to return a list of mutual friends (up to 20), if any- Parameters:
value- value of "need mutual" parameter.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
out
public FriendsGetRequestsQueryWithExtended out(java.lang.Boolean value)
'1' — to return outgoing requests, '0' — to return incoming requests (default)- Parameters:
value- value of "out" parameter.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
sort
public FriendsGetRequestsQueryWithExtended sort(GetRequestsSort value)
Sort order: '1' — by number of mutual friends, '0' — by date- Parameters:
value- value of "sort" parameter. Minimum is 0.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
needViewed
public FriendsGetRequestsQueryWithExtended needViewed(java.lang.Boolean value)
Set need viewed- Parameters:
value- value of "need viewed" parameter. By default 0.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
suggested
public FriendsGetRequestsQueryWithExtended suggested(java.lang.Boolean value)
'1' — to return a list of suggested friends, '0' — to return friend requests (default)- Parameters:
value- value of "suggested" parameter.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
ref
public FriendsGetRequestsQueryWithExtended ref(java.lang.String value)
Set ref- Parameters:
value- value of "ref" parameter.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
fields
public FriendsGetRequestsQueryWithExtended fields(Fields... value)
fields Set fields- Parameters:
value- value of "fields" parameter.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
fields
public FriendsGetRequestsQueryWithExtended fields(java.util.List<Fields> value)
Set fields- Parameters:
value- value of "fields" parameter.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
getThis
protected FriendsGetRequestsQueryWithExtended getThis()
Description copied from class:AbstractQueryBuilderGet reference to this object- Specified by:
getThisin classAbstractQueryBuilder<FriendsGetRequestsQueryWithExtended,GetRequestsExtendedResponse>- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
essentialKeys
protected java.util.List<java.lang.String> essentialKeys()
Description copied from class:AbstractQueryBuilderGet list of required parameter names- Specified by:
essentialKeysin classAbstractQueryBuilder<FriendsGetRequestsQueryWithExtended,GetRequestsExtendedResponse>- Returns:
- list of names
-
-