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

Class BoardAddTopicQuery

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<BoardAddTopicQuery,java.lang.Integer>

com.vk.api.sdk.queries.board.BoardAddTopicQuery

public class BoardAddTopicQuery
extends AbstractQueryBuilder<BoardAddTopicQuery,java.lang.Integer>

Query for Board.addTopic method

Constructor Summary

Constructors

Constructor	Description
BoardAddTopicQuery(VkApiClient client, UserActor actor, int groupId, java.lang.String title)	Creates a AbstractQueryBuilder instance that can be used to build api request with various parameters

Method Summary

Modifier and Type	Method	Description
BoardAddTopicQuery	attachments(java.lang.String... value)	attachments List of media objects attached to the topic, in the following format: "_,_", ' — Type of media object: 'photo' — photo, 'video' — video, 'audio' — audio, 'doc' — document, '' — ID of the media owner.
BoardAddTopicQuery	attachments(java.util.List<java.lang.String> value)	List of media objects attached to the topic, in the following format: "_,_", ' — Type of media object: 'photo' — photo, 'video' — video, 'audio' — audio, 'doc' — document, '' — ID of the media owner.
protected java.util.List<java.lang.String>	essentialKeys()	Get list of required parameter names
BoardAddTopicQuery	fromGroup(java.lang.Boolean value)	For a community: '1' — to post the topic as by the community, '0' — to post the topic as by the user (default)
protected BoardAddTopicQuery	getThis()	Get reference to this object
protected BoardAddTopicQuery	groupId(int value)	ID of the community that owns the discussion board.
BoardAddTopicQuery	text(java.lang.String value)	Text of the topic.
protected BoardAddTopicQuery	title(java.lang.String value)	Topic title.

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

BoardAddTopicQuery

public BoardAddTopicQuery(VkApiClient client,
                          UserActor actor,
                          int groupId,
                          java.lang.String title)

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.

title - value of "title" parameter.

Method Detail

groupId

protected BoardAddTopicQuery 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.

title

protected BoardAddTopicQuery title(java.lang.String value)

Topic title.

Parameters:

value - value of "title" parameter.

Returns:

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

text

public BoardAddTopicQuery text(java.lang.String value)

Text of the topic.

Parameters:

value - value of "text" parameter.

Returns:

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

fromGroup

public BoardAddTopicQuery fromGroup(java.lang.Boolean value)

For a community: '1' — to post the topic as by the community, '0' — to post the topic as by the user (default)

Parameters:

value - value of "from group" parameter.

Returns:

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

attachments

public BoardAddTopicQuery attachments(java.lang.String... value)

attachments List of media objects attached to the topic, in the following format: "_,_", ' — Type of media object: 'photo' — photo, 'video' — video, 'audio' — audio, 'doc' — document, '' — ID of the media owner. '' — Media ID. Example: "photo100172_166443618,photo66748_265827614", , "NOTE: If you try to attach more than one reference, an error will be thrown.",

Parameters:

value - value of "attachments" parameter.

Returns:

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

attachments

public BoardAddTopicQuery attachments(java.util.List<java.lang.String> value)

List of media objects attached to the topic, in the following format: "_,_", ' — Type of media object: 'photo' — photo, 'video' — video, 'audio' — audio, 'doc' — document, '' — ID of the media owner. '' — Media ID. Example: "photo100172_166443618,photo66748_265827614", , "NOTE: If you try to attach more than one reference, an error will be thrown.",

Parameters:

value - value of "attachments" parameter.

Returns:

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

getThis

protected BoardAddTopicQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<BoardAddTopicQuery,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<BoardAddTopicQuery,java.lang.Integer>

Returns:

list of names