Package com.vk.api.sdk.queries.friends
Class FriendsGetSuggestionsQuery
- java.lang.Object
-
- com.vk.api.sdk.client.ApiRequest<R>
-
- com.vk.api.sdk.client.AbstractQueryBuilder<FriendsGetSuggestionsQuery,GetSuggestionsResponse>
-
- com.vk.api.sdk.queries.friends.FriendsGetSuggestionsQuery
-
public class FriendsGetSuggestionsQuery extends AbstractQueryBuilder<FriendsGetSuggestionsQuery,GetSuggestionsResponse>
Query for Friends.getSuggestions method
-
-
Constructor Summary
Constructors Constructor Description FriendsGetSuggestionsQuery(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 FriendsGetSuggestionsQuerycount(java.lang.Integer value)Number of suggestions to return.protected java.util.List<java.lang.String>essentialKeys()Get list of required parameter namesFriendsGetSuggestionsQueryfields(Fields... value)fields Profile fields to return.FriendsGetSuggestionsQueryfields(java.util.List<Fields> value)Profile fields to return.FriendsGetSuggestionsQueryfilter(java.lang.String... value)filter Types of potential friends to return: 'mutual' — users with many mutual friends , 'contacts' — users found with the [vk.com/dev/account.importContacts|account.importContacts] method , 'mutual_contacts' — users who imported the same contacts as the current user with the [vk.com/dev/account.importContacts|account.importContacts] methodFriendsGetSuggestionsQueryfilter(java.util.List<java.lang.String> value)Types of potential friends to return: 'mutual' — users with many mutual friends , 'contacts' — users found with the [vk.com/dev/account.importContacts|account.importContacts] method , 'mutual_contacts' — users who imported the same contacts as the current user with the [vk.com/dev/account.importContacts|account.importContacts] methodprotected FriendsGetSuggestionsQuerygetThis()Get reference to this objectFriendsGetSuggestionsQuerynameCase(GetSuggestionsNameCase value)Case for declension of user name and surname: , 'nom' — nominative (default) , 'gen' — genitive , 'dat' — dative , 'acc' — accusative , 'ins' — instrumental , 'abl' — prepositionalFriendsGetSuggestionsQueryoffset(java.lang.Integer value)Offset needed to return a specific subset of suggestions.-
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
-
FriendsGetSuggestionsQuery
public FriendsGetSuggestionsQuery(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
-
count
public FriendsGetSuggestionsQuery count(java.lang.Integer value)
Number of suggestions to return.- Parameters:
value- value of "count" parameter. Maximum is 500. Minimum is 0. By default 500.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
offset
public FriendsGetSuggestionsQuery offset(java.lang.Integer value)
Offset needed to return a specific subset of suggestions.- Parameters:
value- value of "offset" parameter. Minimum is 0.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
nameCase
public FriendsGetSuggestionsQuery nameCase(GetSuggestionsNameCase value)
Case for declension of user name and surname: , 'nom' — nominative (default) , 'gen' — genitive , 'dat' — dative , 'acc' — accusative , 'ins' — instrumental , 'abl' — prepositional- Parameters:
value- value of "name case" parameter.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
filter
public FriendsGetSuggestionsQuery filter(java.lang.String... value)
filter Types of potential friends to return: 'mutual' — users with many mutual friends , 'contacts' — users found with the [vk.com/dev/account.importContacts|account.importContacts] method , 'mutual_contacts' — users who imported the same contacts as the current user with the [vk.com/dev/account.importContacts|account.importContacts] method- Parameters:
value- value of "filter" parameter.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
filter
public FriendsGetSuggestionsQuery filter(java.util.List<java.lang.String> value)
Types of potential friends to return: 'mutual' — users with many mutual friends , 'contacts' — users found with the [vk.com/dev/account.importContacts|account.importContacts] method , 'mutual_contacts' — users who imported the same contacts as the current user with the [vk.com/dev/account.importContacts|account.importContacts] method- Parameters:
value- value of "filter" parameter.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
fields
public FriendsGetSuggestionsQuery fields(Fields... value)
fields Profile fields to return. Sample values: 'nickname', 'screen_name', 'sex', 'bdate' (birthdate), 'city', 'country', 'timezone', 'photo', 'photo_medium', 'photo_big', 'has_mobile', 'rate', 'contacts', 'education', 'online', 'counters'.- Parameters:
value- value of "fields" parameter.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
fields
public FriendsGetSuggestionsQuery fields(java.util.List<Fields> value)
Profile fields to return. Sample values: 'nickname', 'screen_name', 'sex', 'bdate' (birthdate), 'city', 'country', 'timezone', 'photo', 'photo_medium', 'photo_big', 'has_mobile', 'rate', 'contacts', 'education', 'online', 'counters'.- Parameters:
value- value of "fields" parameter.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
getThis
protected FriendsGetSuggestionsQuery getThis()
Description copied from class:AbstractQueryBuilderGet reference to this object- Specified by:
getThisin classAbstractQueryBuilder<FriendsGetSuggestionsQuery,GetSuggestionsResponse>- 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<FriendsGetSuggestionsQuery,GetSuggestionsResponse>- Returns:
- list of names
-
-