Package com.vk.api.sdk.queries.friends

Class FriendsGetOnlineQuery

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<FriendsGetOnlineQuery,java.util.List<java.lang.Integer>>

com.vk.api.sdk.queries.friends.FriendsGetOnlineQuery

public class FriendsGetOnlineQuery
extends AbstractQueryBuilder<FriendsGetOnlineQuery,java.util.List<java.lang.Integer>>

Query for Friends.getOnline method

Constructor Summary

Constructors

Constructor	Description
FriendsGetOnlineQuery(VkApiClient client, UserActor actor)	Creates a AbstractQueryBuilder instance that can be used to build api request with various parameters

Method Summary

Modifier and Type	Method	Description
FriendsGetOnlineQuery	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 FriendsGetOnlineQuery	getThis()	Get reference to this object
FriendsGetOnlineQuery	listId(java.lang.Integer value)	Friend list ID.
FriendsGetOnlineQuery	offset(java.lang.Integer value)	Offset needed to return a specific subset of friends.
FriendsGetOnlineQuery	onlineMobile(java.lang.Boolean value)	'1' — to return an additional 'online_mobile' field, '0' — (default),
FriendsGetOnlineQuery	order(java.lang.String value)	Sort order: 'random' — random order
FriendsGetOnlineQuery	userId(java.lang.Integer value)	User ID.

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

Methods inherited from class java.lang.Object

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

Constructor Detail

FriendsGetOnlineQuery

public FriendsGetOnlineQuery(VkApiClient client,
                             UserActor actor)

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

Parameters:

client - VK API client

actor - actor with access token

Method Detail

userId

public FriendsGetOnlineQuery userId(java.lang.Integer value)

User ID.

Parameters:

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

Returns:

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

listId

public FriendsGetOnlineQuery 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

public FriendsGetOnlineQuery 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 FriendsGetOnlineQuery 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 FriendsGetOnlineQuery 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 FriendsGetOnlineQuery 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 FriendsGetOnlineQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<FriendsGetOnlineQuery,java.util.List<java.lang.Integer>>

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<FriendsGetOnlineQuery,java.util.List<java.lang.Integer>>

Returns:

list of names