Package com.vk.api.sdk.queries.market

Class MarketGetCommentsQuery

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<MarketGetCommentsQuery,GetCommentsResponse>

com.vk.api.sdk.queries.market.MarketGetCommentsQuery

public class MarketGetCommentsQuery
extends AbstractQueryBuilder<MarketGetCommentsQuery,GetCommentsResponse>

Query for Market.getComments method

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
MarketGetCommentsQuery	count(java.lang.Integer value)	Number of results to return.
protected java.util.List<java.lang.String>	essentialKeys()	Get list of required parameter names
MarketGetCommentsQuery	extended(java.lang.Boolean value)	'1' — comments will be returned as numbered objects, in addition lists of 'profiles' and 'groups' objects will be returned.
MarketGetCommentsQuery	fields(Fields... value)	fields List of additional profile fields to return.
MarketGetCommentsQuery	fields(java.util.List<Fields> value)	List of additional profile fields to return.
protected MarketGetCommentsQuery	getThis()	Get reference to this object
protected MarketGetCommentsQuery	itemId(int value)	Item ID.
MarketGetCommentsQuery	needLikes(java.lang.Boolean value)	'1' — to return likes info.
MarketGetCommentsQuery	offset(java.lang.Integer value)	Set offset
protected MarketGetCommentsQuery	ownerId(int value)	ID of an item owner community
MarketGetCommentsQuery	sort(GetCommentsSort value)	Sort order ('asc' — from old to new, 'desc' — from new to old)
MarketGetCommentsQuery	startCommentId(java.lang.Integer value)	ID of a comment to start a list from (details below).

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

MarketGetCommentsQuery

public MarketGetCommentsQuery(VkApiClient client,
                              UserActor actor,
                              int ownerId,
                              int itemId)

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

ownerId - value of "owner id" parameter.

itemId - value of "item id" parameter. Minimum is 0.

Method Detail

ownerId

protected MarketGetCommentsQuery ownerId(int value)

ID of an item owner community

Parameters:

value - value of "owner id" parameter.

Returns:

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

itemId

protected MarketGetCommentsQuery itemId(int value)

Item ID.

Parameters:

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

Returns:

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

needLikes

public MarketGetCommentsQuery needLikes(java.lang.Boolean value)

'1' — to return likes info.

Parameters:

value - value of "need likes" parameter.

Returns:

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

startCommentId

public MarketGetCommentsQuery startCommentId(java.lang.Integer value)

ID of a comment to start a list from (details below).

Parameters:

value - value of "start comment id" parameter. Minimum is 0.

Returns:

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

offset

public MarketGetCommentsQuery offset(java.lang.Integer value)

Set offset

Parameters:

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

Returns:

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

count

public MarketGetCommentsQuery count(java.lang.Integer value)

Number of results to return.

Parameters:

value - value of "count" parameter. Maximum is 100. Minimum is 0. By default 20.

Returns:

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

sort

public MarketGetCommentsQuery sort(GetCommentsSort value)

Sort order ('asc' — from old to new, 'desc' — from new to old)

Parameters:

value - value of "sort" parameter. By default asc.

Returns:

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

extended

public MarketGetCommentsQuery extended(java.lang.Boolean value)

'1' — comments will be returned as numbered objects, in addition lists of 'profiles' and 'groups' objects will be returned.

Parameters:

value - value of "extended" parameter.

Returns:

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

fields

public MarketGetCommentsQuery fields(Fields... value)

fields List of additional profile fields to return. See the [vk.com/dev/fields|details]

Parameters:

value - value of "fields" parameter.

Returns:

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

fields

public MarketGetCommentsQuery fields(java.util.List<Fields> value)

List of additional profile fields to return. See the [vk.com/dev/fields|details]

Parameters:

value - value of "fields" parameter.

Returns:

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

getThis

protected MarketGetCommentsQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<MarketGetCommentsQuery,GetCommentsResponse>

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<MarketGetCommentsQuery,GetCommentsResponse>

Returns:

list of names