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

Class GroupsGetBannedQuery

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<GroupsGetBannedQuery,GetBannedResponse>

com.vk.api.sdk.queries.groups.GroupsGetBannedQuery

public class GroupsGetBannedQuery
extends AbstractQueryBuilder<GroupsGetBannedQuery,GetBannedResponse>

Query for Groups.getBanned method

Constructor Summary

Constructors

Constructor	Description
GroupsGetBannedQuery(VkApiClient client, GroupActor actor, int groupId)	Creates a AbstractQueryBuilder instance that can be used to build api request with various parameters
GroupsGetBannedQuery(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
GroupsGetBannedQuery	count(java.lang.Integer value)	Number of users to return.
protected java.util.List<java.lang.String>	essentialKeys()	Get list of required parameter names
GroupsGetBannedQuery	fields(UserGroupFields... value)	fields Set fields
GroupsGetBannedQuery	fields(java.util.List<UserGroupFields> value)	Set fields
protected GroupsGetBannedQuery	getThis()	Get reference to this object
protected GroupsGetBannedQuery	groupId(int value)	Community ID.
GroupsGetBannedQuery	offset(java.lang.Integer value)	Offset needed to return a specific subset of users.
GroupsGetBannedQuery	ownerId(java.lang.Integer value)	Set owner id

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

GroupsGetBannedQuery

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

GroupsGetBannedQuery

public GroupsGetBannedQuery(VkApiClient client,
                            GroupActor 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 GroupsGetBannedQuery groupId(int value)

Community ID.

Parameters:

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

Returns:

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

offset

public GroupsGetBannedQuery offset(java.lang.Integer value)

Offset needed to return a specific subset of users.

Parameters:

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

Returns:

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

count

public GroupsGetBannedQuery count(java.lang.Integer value)

Number of users to return.

Parameters:

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

Returns:

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

ownerId

public GroupsGetBannedQuery 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.

fields

public GroupsGetBannedQuery fields(UserGroupFields... value)

fields Set fields

Parameters:

value - value of "fields" parameter.

Returns:

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

fields

public GroupsGetBannedQuery fields(java.util.List<UserGroupFields> value)

Set fields

Parameters:

value - value of "fields" parameter.

Returns:

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

getThis

protected GroupsGetBannedQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<GroupsGetBannedQuery,GetBannedResponse>

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<GroupsGetBannedQuery,GetBannedResponse>

Returns:

list of names