com.vk.api.sdk.queries.friends

Class FriendsGetOnlineQueryWithOnlineMobile

java.lang.Object

com.vk.api.sdk.client.ApiRequest<R>

com.vk.api.sdk.client.AbstractQueryBuilder<FriendsGetOnlineQueryWithOnlineMobile,GetOnlineOnlineMobileResponse>

com.vk.api.sdk.queries.friends.FriendsGetOnlineQueryWithOnlineMobile

public class FriendsGetOnlineQueryWithOnlineMobile
extends AbstractQueryBuilder<FriendsGetOnlineQueryWithOnlineMobile,GetOnlineOnlineMobileResponse>

Query for Friends.getOnline method

Constructor Summary

Constructors

Constructor and Description
FriendsGetOnlineQueryWithOnlineMobile(VkApiClient client, UserActor actor, java.lang.Boolean onlineMobile) Creates a AbstractQueryBuilder instance that can be used to build user api request with various parameters

Method Summary

Modifier and Type	Method and Description
FriendsGetOnlineQueryWithOnlineMobile	count(java.lang.Integer value) Number of friends to return.
protected java.util.List<java.lang.String>	essentialKeys() Get list of required parameter names
protected FriendsGetOnlineQueryWithOnlineMobile	getThis() Get reference to this object
FriendsGetOnlineQueryWithOnlineMobile	listId(java.lang.Integer value) Friend list ID.
FriendsGetOnlineQueryWithOnlineMobile	offset(java.lang.Integer value) Offset needed to return a specific subset of friends.
protected FriendsGetOnlineQueryWithOnlineMobile	onlineMobile(java.lang.Boolean value) '1' - to return an additional 'online_mobile' field, '0' - (default),
FriendsGetOnlineQueryWithOnlineMobile	order(java.lang.String value) Sort order: 'random' - random order
FriendsGetOnlineQueryWithOnlineMobile	userId(java.lang.Long value) User ID.

Methods inherited from class com.vk.api.sdk.client.AbstractQueryBuilder

accessToken, build, captchaKey, captchaSid, clientSecret, confirm, getBody, getMethod, getParams, getQueryHeaders, lang, toString, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, version, withHeader, withHeaders

Methods inherited from class com.vk.api.sdk.client.ApiRequest

addHeader, addHeaders, execute, executeAsRaw, executeAsString, executeAsStringWithReturningFullInfo, executeTypeable, executeTypeableWithoutRetry, executeWithoutRetry, getClient, getCookie, getGson, getHeaders, getResponseClass, getUrl, setCookie, setCookies, setHeaders, setHeaders

Methods inherited from class java.lang.Object

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

Constructor Detail

FriendsGetOnlineQueryWithOnlineMobile

public FriendsGetOnlineQueryWithOnlineMobile(VkApiClient client,
                                             UserActor actor,
                                             java.lang.Boolean onlineMobile)

Creates a AbstractQueryBuilder instance that can be used to build user api request with various parameters

Parameters:

client - VK API client

actor - actor with access token

Method Detail

userId

public FriendsGetOnlineQueryWithOnlineMobile userId(java.lang.Long value)

User ID.

Parameters:

value - value of "user id" parameter. Minimum is 0. Entity - owner

Returns:

a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

listId

public FriendsGetOnlineQueryWithOnlineMobile listId(java.lang.Integer value)

Friend list ID. If this parameter is not set, information about all online friends is returned.

Parameters:

value - value of "list id" parameter. Minimum is 0.

Returns:

a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

onlineMobile

protected FriendsGetOnlineQueryWithOnlineMobile onlineMobile(java.lang.Boolean value)

'1' - to return an additional 'online_mobile' field, '0' - (default),

Parameters:

value - value of "online mobile" parameter.

Returns:

a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

order

public FriendsGetOnlineQueryWithOnlineMobile order(java.lang.String value)

Sort order: 'random' - random order

Parameters:

value - value of "order" parameter.

Returns:

a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

count

public FriendsGetOnlineQueryWithOnlineMobile count(java.lang.Integer value)

Number of friends to return.

Parameters:

value - value of "count" parameter. Minimum is 0.

Returns:

a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

offset

public FriendsGetOnlineQueryWithOnlineMobile offset(java.lang.Integer value)

Offset needed to return a specific subset of friends.

Parameters:

value - value of "offset" parameter. Minimum is 0.

Returns:

a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

getThis

protected FriendsGetOnlineQueryWithOnlineMobile getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<FriendsGetOnlineQueryWithOnlineMobile,GetOnlineOnlineMobileResponse>

Returns:

a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

essentialKeys

protected java.util.List<java.lang.String> essentialKeys()

Description copied from class: AbstractQueryBuilder

Get list of required parameter names

Specified by:

essentialKeys in class AbstractQueryBuilder<FriendsGetOnlineQueryWithOnlineMobile,GetOnlineOnlineMobileResponse>

Returns:

list of names