com.vk.api.sdk.queries.board

Class BoardGetTopicsQueryWithExtended

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<BoardGetTopicsQueryWithExtended,GetTopicsExtendedResponse>

com.vk.api.sdk.queries.board.BoardGetTopicsQueryWithExtended

public class BoardGetTopicsQueryWithExtended
extends AbstractQueryBuilder<BoardGetTopicsQueryWithExtended,GetTopicsExtendedResponse>

Query for Board.getTopics method

Constructor Summary

Constructors

Constructor and Description
BoardGetTopicsQueryWithExtended(VkApiClient client, ServiceActor actor, java.lang.Long groupId) Creates a AbstractQueryBuilder instance that can be used to build service api request with various parameters
BoardGetTopicsQueryWithExtended(VkApiClient client, UserActor actor, java.lang.Long groupId) Creates a AbstractQueryBuilder instance that can be used to build user api request with various parameters

Method Summary

Modifier and Type	Method and Description
BoardGetTopicsQueryWithExtended	count(java.lang.Integer value) Number of topics to return.
protected java.util.List<java.lang.String>	essentialKeys() Get list of required parameter names
protected BoardGetTopicsQueryWithExtended	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 BoardGetTopicsQueryWithExtended	getThis() Get reference to this object
BoardGetTopicsQueryWithExtended	groupId(java.lang.Long value) ID of the community that owns the discussion board.
BoardGetTopicsQueryWithExtended	offset(java.lang.Integer value) Offset needed to return a specific subset of topics.
BoardGetTopicsQueryWithExtended	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.
BoardGetTopicsQueryWithExtended	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.
BoardGetTopicsQueryWithExtended	previewLength(java.lang.Integer value) Number of characters after which to truncate the previewed comment.
BoardGetTopicsQueryWithExtended	topicIds(java.lang.Integer... value) topicIds IDs of topics to be returned (100 maximum).
BoardGetTopicsQueryWithExtended	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, 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

BoardGetTopicsQueryWithExtended

public BoardGetTopicsQueryWithExtended(VkApiClient client,
                                       UserActor actor,
                                       java.lang.Long groupId)

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

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

BoardGetTopicsQueryWithExtended

public BoardGetTopicsQueryWithExtended(VkApiClient client,
                                       ServiceActor actor,
                                       java.lang.Long groupId)

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

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

Method Detail

groupId

public BoardGetTopicsQueryWithExtended groupId(java.lang.Long value)

ID of the community that owns the discussion board.

Parameters:

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

Returns:

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

order

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

protected BoardGetTopicsQueryWithExtended 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 BoardGetTopicsQueryWithExtended 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 BoardGetTopicsQueryWithExtended 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 BoardGetTopicsQueryWithExtended topicIds(java.lang.Integer... value)

topicIds 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 BoardGetTopicsQueryWithExtended 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 BoardGetTopicsQueryWithExtended getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<BoardGetTopicsQueryWithExtended,GetTopicsExtendedResponse>

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<BoardGetTopicsQueryWithExtended,GetTopicsExtendedResponse>

Returns:

list of names