Package com.vk.api.sdk.queries.board

Class BoardGetTopicsQuery

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<BoardGetTopicsQuery,GetTopicsResponse>

com.vk.api.sdk.queries.board.BoardGetTopicsQuery

public class BoardGetTopicsQuery
extends AbstractQueryBuilder<BoardGetTopicsQuery,GetTopicsResponse>

Query for Board.getTopics method

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
BoardGetTopicsQuery	count(java.lang.Integer value)	Number of topics to return.
protected java.util.List<java.lang.String>	essentialKeys()	Get list of required parameter names
BoardGetTopicsQuery	extended(java.lang.Boolean value)	'1' — to return information about users who created topics or who posted there last, '0' — to return no additional fields (default)
protected BoardGetTopicsQuery	getThis()	Get reference to this object
protected BoardGetTopicsQuery	groupId(int value)	ID of the community that owns the discussion board.
BoardGetTopicsQuery	offset(java.lang.Integer value)	Offset needed to return a specific subset of topics.
BoardGetTopicsQuery	order(GetTopicsOrder value)	Sort order: '1' — by date updated in reverse chronological order.
BoardGetTopicsQuery	preview(GetTopicsPreview value)	'1' — to return the first comment in each topic,, '2' — to return the last comment in each topic,, '0' — to return no comments.
BoardGetTopicsQuery	previewLength(java.lang.Integer value)	Number of characters after which to truncate the previewed comment.
BoardGetTopicsQuery	topicIds(java.lang.Integer... value)	topic_ids IDs of topics to be returned (100 maximum).
BoardGetTopicsQuery	topicIds(java.util.List<java.lang.Integer> value)	IDs of topics to be returned (100 maximum).

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

BoardGetTopicsQuery

public BoardGetTopicsQuery(VkApiClient client,
                           UserActor actor,
                           int groupId)

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

groupId - value of "group id" parameter. Minimum is 1.

BoardGetTopicsQuery

public BoardGetTopicsQuery(VkApiClient client,
                           ServiceActor actor,
                           int groupId)

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

groupId - value of "group id" parameter. Minimum is 1.

Method Detail

groupId

protected BoardGetTopicsQuery groupId(int value)

ID of the community that owns the discussion board.

Parameters:

value - value of "group id" parameter. Minimum is 1.

Returns:

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

order

public BoardGetTopicsQuery order(GetTopicsOrder value)

Sort order: '1' — by date updated in reverse chronological order. '2' — by date created in reverse chronological order. '-1' — by date updated in chronological order. '-2' — by date created in chronological order. If no sort order is specified, topics are returned in the order specified by the group administrator. Pinned topics are returned first, regardless of the sorting.

Parameters:

value - value of "order" parameter.

Returns:

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

offset

public BoardGetTopicsQuery offset(java.lang.Integer value)

Offset needed to return a specific subset of topics.

Parameters:

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

Returns:

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

count

public BoardGetTopicsQuery count(java.lang.Integer value)

Number of topics to return.

Parameters:

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

Returns:

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

extended

public BoardGetTopicsQuery extended(java.lang.Boolean value)

'1' — to return information about users who created topics or who posted there last, '0' — to return no additional fields (default)

Parameters:

value - value of "extended" parameter.

Returns:

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

preview

public BoardGetTopicsQuery preview(GetTopicsPreview value)

'1' — to return the first comment in each topic,, '2' — to return the last comment in each topic,, '0' — to return no comments. By default: '0'.

Parameters:

value - value of "preview" parameter.

Returns:

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

previewLength

public BoardGetTopicsQuery previewLength(java.lang.Integer value)

Number of characters after which to truncate the previewed comment. To preview the full comment, specify '0'.

Parameters:

value - value of "preview length" parameter. Minimum is 0. By default 90.

Returns:

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

topicIds

public BoardGetTopicsQuery topicIds(java.lang.Integer... value)

topic_ids IDs of topics to be returned (100 maximum). By default, all topics are returned. If this parameter is set, the 'order', 'offset', and 'count' parameters are ignored.

Parameters:

value - value of "topic ids" parameter.

Returns:

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

topicIds

public BoardGetTopicsQuery topicIds(java.util.List<java.lang.Integer> value)

IDs of topics to be returned (100 maximum). By default, all topics are returned. If this parameter is set, the 'order', 'offset', and 'count' parameters are ignored.

Parameters:

value - value of "topic ids" parameter.

Returns:

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

getThis

protected BoardGetTopicsQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<BoardGetTopicsQuery,GetTopicsResponse>

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<BoardGetTopicsQuery,GetTopicsResponse>

Returns:

list of names