Package com.vk.api.sdk.queries.groups

Class GroupsBanQuery

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<GroupsBanQuery,OkResponse>

com.vk.api.sdk.queries.groups.GroupsBanQuery

public class GroupsBanQuery
extends AbstractQueryBuilder<GroupsBanQuery,OkResponse>

Query for Groups.ban method

Constructor Summary

Constructors

Constructor	Description
GroupsBanQuery(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
GroupsBanQuery	comment(java.lang.String value)	Set comment
GroupsBanQuery	commentVisible(java.lang.Boolean value)	Set comment visible
GroupsBanQuery	endDate(java.lang.Integer value)	Set end date
protected java.util.List<java.lang.String>	essentialKeys()	Get list of required parameter names
protected GroupsBanQuery	getThis()	Get reference to this object
protected GroupsBanQuery	groupId(int value)	Set group id
GroupsBanQuery	ownerId(java.lang.Integer value)	Set owner id
GroupsBanQuery	reason(java.lang.Integer value)	Set reason

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

GroupsBanQuery

public GroupsBanQuery(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.

Method Detail

groupId

protected GroupsBanQuery groupId(int value)

Set group id

Parameters:

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

Returns:

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

ownerId

public GroupsBanQuery ownerId(java.lang.Integer value)

Set owner id

Parameters:

value - value of "owner id" parameter.

Returns:

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

endDate

public GroupsBanQuery endDate(java.lang.Integer value)

Set end date

Parameters:

value - value of "end date" parameter. Minimum is 0.

Returns:

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

reason

public GroupsBanQuery reason(java.lang.Integer value)

Set reason

Parameters:

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

Returns:

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

comment

public GroupsBanQuery comment(java.lang.String value)

Set comment

Parameters:

value - value of "comment" parameter.

Returns:

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

commentVisible

public GroupsBanQuery commentVisible(java.lang.Boolean value)

Set comment visible

Parameters:

value - value of "comment visible" parameter.

Returns:

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

getThis

protected GroupsBanQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<GroupsBanQuery,OkResponse>

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<GroupsBanQuery,OkResponse>

Returns:

list of names