com.vk.api.sdk.queries.likes

Class LikesGetListQueryWithExtended

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<LikesGetListQueryWithExtended,GetListExtendedResponse>

com.vk.api.sdk.queries.likes.LikesGetListQueryWithExtended

public class LikesGetListQueryWithExtended
extends AbstractQueryBuilder<LikesGetListQueryWithExtended,GetListExtendedResponse>

Query for Likes.getList method

Constructor Summary

Constructors

Constructor and Description
LikesGetListQueryWithExtended(VkApiClient client, ServiceActor actor, Type type) Creates a AbstractQueryBuilder instance that can be used to build service api request with various parameters
LikesGetListQueryWithExtended(VkApiClient client, UserActor actor, Type type) Creates a AbstractQueryBuilder instance that can be used to build user api request with various parameters

Method Summary

Modifier and Type	Method and Description
LikesGetListQueryWithExtended	count(java.lang.Integer value) Number of user IDs to return (maximum '1000').
protected java.util.List<java.lang.String>	essentialKeys() Get list of required parameter names
protected LikesGetListQueryWithExtended	extended(java.lang.Boolean value) Specifies whether extended information will be returned. '1' - to return extended information about users and communities from the 'Likes' list, '0' - to return no additional information (default)
LikesGetListQueryWithExtended	fields(java.util.List<java.lang.String> value) Set fields
LikesGetListQueryWithExtended	fields(java.lang.String... value) fields Set fields
LikesGetListQueryWithExtended	filter(GetListFilter value) Filters to apply: 'likes' - returns information about all users who liked the object (default), 'copies' - returns information only about users who told their friends about the object
LikesGetListQueryWithExtended	friendsOnly(GetListFriendsOnly value) Specifies which users are returned: '1' - to return only the current user's friends, '0' - to return all users (default)
protected LikesGetListQueryWithExtended	getThis() Get reference to this object
LikesGetListQueryWithExtended	itemId(java.lang.Integer value) Object ID.
LikesGetListQueryWithExtended	offset(java.lang.Integer value) Offset needed to select a specific subset of users.
LikesGetListQueryWithExtended	ownerId(java.lang.Long value) ID of the user, community, or application that owns the object.
LikesGetListQueryWithExtended	pageUrl(java.lang.String value) URL of the page where the [vk.com/dev/Like|Like widget] is installed.
LikesGetListQueryWithExtended	skipOwn(java.lang.Boolean value) Set skip own
LikesGetListQueryWithExtended	type(Type value) , Object type: 'post' - post on user or community wall, 'comment' - comment on a wall post, 'photo' - photo, 'audio' - audio, 'video' - video, 'story' - story, 'note' - note, 'photo_comment' - comment on the photo, 'video_comment' - comment on the video, 'topic_comment' - comment in the discussion, 'sitepage' - page of the site where the [vk.com/dev/Like|Like widget] is installed

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

LikesGetListQueryWithExtended

public LikesGetListQueryWithExtended(VkApiClient client,
                                     UserActor actor,
                                     Type type)

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

type - value of "type" parameter.

LikesGetListQueryWithExtended

public LikesGetListQueryWithExtended(VkApiClient client,
                                     ServiceActor actor,
                                     Type type)

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

Parameters:

client - VK API client

actor - actor with access token

type - value of "type" parameter.

Method Detail

type

public LikesGetListQueryWithExtended type(Type value)

, Object type: 'post' - post on user or community wall, 'comment' - comment on a wall post, 'photo' - photo, 'audio' - audio, 'video' - video, 'story' - story, 'note' - note, 'photo_comment' - comment on the photo, 'video_comment' - comment on the video, 'topic_comment' - comment in the discussion, 'sitepage' - page of the site where the [vk.com/dev/Like|Like widget] is installed

Parameters:

value - value of "type" parameter.

Returns:

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

ownerId

public LikesGetListQueryWithExtended ownerId(java.lang.Long value)

ID of the user, community, or application that owns the object. If the 'type' parameter is set as 'sitepage', the application ID is passed as 'owner_id'. Use negative value for a community id. If the 'type' parameter is not set, the 'owner_id' is assumed to be either the current user or the same application ID as if the 'type' parameter was set to 'sitepage'.

Parameters:

value - value of "owner id" parameter. Entity - owner

Returns:

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

itemId

public LikesGetListQueryWithExtended itemId(java.lang.Integer value)

Object ID. If 'type' is set as 'sitepage', 'item_id' can include the 'page_id' parameter value used during initialization of the [vk.com/dev/Like|Like widget].

Parameters:

value - value of "item id" parameter.

Returns:

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

pageUrl

public LikesGetListQueryWithExtended pageUrl(java.lang.String value)

URL of the page where the [vk.com/dev/Like|Like widget] is installed. Used instead of the 'item_id' parameter.

Parameters:

value - value of "page url" parameter.

Returns:

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

filter

public LikesGetListQueryWithExtended filter(GetListFilter value)

Filters to apply: 'likes' - returns information about all users who liked the object (default), 'copies' - returns information only about users who told their friends about the object

Parameters:

value - value of "filter" parameter.

Returns:

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

friendsOnly

public LikesGetListQueryWithExtended friendsOnly(GetListFriendsOnly value)

Specifies which users are returned: '1' - to return only the current user's friends, '0' - to return all users (default)

Parameters:

value - value of "friends only" parameter. By default 0.

Returns:

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

extended

protected LikesGetListQueryWithExtended extended(java.lang.Boolean value)

Specifies whether extended information will be returned. '1' - to return extended information about users and communities from the 'Likes' list, '0' - to return no additional information (default)

Parameters:

value - value of "extended" parameter.

Returns:

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

offset

public LikesGetListQueryWithExtended offset(java.lang.Integer value)

Offset needed to select a specific subset of users.

Parameters:

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

Returns:

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

count

public LikesGetListQueryWithExtended count(java.lang.Integer value)

Number of user IDs to return (maximum '1000'). Default is '100' if 'friends_only' is set to '0', otherwise, the default is '10' if 'friends_only' is set to '1'.

Parameters:

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

Returns:

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

skipOwn

public LikesGetListQueryWithExtended skipOwn(java.lang.Boolean value)

Set skip own

Parameters:

value - value of "skip own" parameter.

Returns:

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

fields

public LikesGetListQueryWithExtended fields(java.lang.String... value)

fields Set fields

Parameters:

value - value of "fields" parameter.

Returns:

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

fields

public LikesGetListQueryWithExtended fields(java.util.List<java.lang.String> value)

Set fields

Parameters:

value - value of "fields" parameter.

Returns:

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

getThis

protected LikesGetListQueryWithExtended getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<LikesGetListQueryWithExtended,GetListExtendedResponse>

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<LikesGetListQueryWithExtended,GetListExtendedResponse>

Returns:

list of names