com.vk.api.sdk.queries.groups

Class GroupsGetQueryWithObjectExtended

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<GroupsGetQueryWithObjectExtended,GetObjectExtendedResponse>

com.vk.api.sdk.queries.groups.GroupsGetQueryWithObjectExtended

public class GroupsGetQueryWithObjectExtended
extends AbstractQueryBuilder<GroupsGetQueryWithObjectExtended,GetObjectExtendedResponse>

Query for Groups.get method

Constructor Summary

Constructors

Constructor and Description
GroupsGetQueryWithObjectExtended(VkApiClient client, UserActor actor) Creates a AbstractQueryBuilder instance that can be used to build user api request with various parameters

Method Summary

Modifier and Type	Method and Description
GroupsGetQueryWithObjectExtended	count(java.lang.Integer value) Number of communities to return.
protected java.util.List<java.lang.String>	essentialKeys() Get list of required parameter names
GroupsGetQueryWithObjectExtended	extended(java.lang.Boolean value) '1' - to return complete information about a user's communities, '0' - to return a list of community IDs without any additional fields (default),
GroupsGetQueryWithObjectExtended	fields(Fields... value) fields Profile fields to return.
GroupsGetQueryWithObjectExtended	fields(java.util.List<Fields> value) Profile fields to return.
GroupsGetQueryWithObjectExtended	filter(Filter... value) filter Types of communities to return: 'admin' - to return communities administered by the user , 'editor' - to return communities where the user is an administrator or editor, 'moder' - to return communities where the user is an administrator, editor, or moderator, 'groups' - to return only groups, 'publics' - to return only public pages, 'events' - to return only events
GroupsGetQueryWithObjectExtended	filter(java.util.List<Filter> value) Types of communities to return: 'admin' - to return communities administered by the user , 'editor' - to return communities where the user is an administrator or editor, 'moder' - to return communities where the user is an administrator, editor, or moderator, 'groups' - to return only groups, 'publics' - to return only public pages, 'events' - to return only events
protected GroupsGetQueryWithObjectExtended	getThis() Get reference to this object
GroupsGetQueryWithObjectExtended	offset(java.lang.Integer value) Offset needed to return a specific subset of communities.
GroupsGetQueryWithObjectExtended	userId(java.lang.Long value) User ID.

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

GroupsGetQueryWithObjectExtended

public GroupsGetQueryWithObjectExtended(VkApiClient client,
                                        UserActor actor)

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

Method Detail

userId

public GroupsGetQueryWithObjectExtended userId(java.lang.Long value)

User ID.

Parameters:

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

Returns:

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

extended

public GroupsGetQueryWithObjectExtended extended(java.lang.Boolean value)

'1' - to return complete information about a user's communities, '0' - to return a list of community IDs without any additional fields (default),

Parameters:

value - value of "extended" parameter.

Returns:

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

offset

public GroupsGetQueryWithObjectExtended offset(java.lang.Integer value)

Offset needed to return a specific subset of communities.

Parameters:

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

Returns:

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

count

public GroupsGetQueryWithObjectExtended count(java.lang.Integer value)

Number of communities to return.

Parameters:

value - value of "count" parameter. Maximum is 1000. Minimum is 0.

Returns:

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

filter

public GroupsGetQueryWithObjectExtended filter(Filter... value)

filter Types of communities to return: 'admin' - to return communities administered by the user , 'editor' - to return communities where the user is an administrator or editor, 'moder' - to return communities where the user is an administrator, editor, or moderator, 'groups' - to return only groups, 'publics' - to return only public pages, 'events' - to return only events

Parameters:

value - value of "filter" parameter.

Returns:

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

filter

public GroupsGetQueryWithObjectExtended filter(java.util.List<Filter> value)

Types of communities to return: 'admin' - to return communities administered by the user , 'editor' - to return communities where the user is an administrator or editor, 'moder' - to return communities where the user is an administrator, editor, or moderator, 'groups' - to return only groups, 'publics' - to return only public pages, 'events' - to return only events

Parameters:

value - value of "filter" parameter.

Returns:

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

fields

public GroupsGetQueryWithObjectExtended fields(Fields... value)

fields Profile fields to return.

Parameters:

value - value of "fields" parameter.

Returns:

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

fields

public GroupsGetQueryWithObjectExtended fields(java.util.List<Fields> value)

Profile fields to return.

Parameters:

value - value of "fields" parameter.

Returns:

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

getThis

protected GroupsGetQueryWithObjectExtended getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<GroupsGetQueryWithObjectExtended,GetObjectExtendedResponse>

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<GroupsGetQueryWithObjectExtended,GetObjectExtendedResponse>

Returns:

list of names