com.vk.api.sdk.queries.groups

Class GroupsGetAddressesQuery

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<GroupsGetAddressesQuery,GetAddressesResponse>

com.vk.api.sdk.queries.groups.GroupsGetAddressesQuery

public class GroupsGetAddressesQuery
extends AbstractQueryBuilder<GroupsGetAddressesQuery,GetAddressesResponse>

Query for Groups.getAddresses method

Constructor Summary

Constructors

Constructor and Description
GroupsGetAddressesQuery(VkApiClient client, ServiceActor actor) Creates a AbstractQueryBuilder instance that can be used to build service api request with various parameters
GroupsGetAddressesQuery(VkApiClient client, ServiceActor actor, java.lang.Long groupId) Creates a AbstractQueryBuilder instance that can be used to build service api request with various parameters
GroupsGetAddressesQuery(VkApiClient client, UserActor actor) Creates a AbstractQueryBuilder instance that can be used to build user api request with various parameters
GroupsGetAddressesQuery(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
GroupsGetAddressesQuery	addressIds(java.lang.Integer... value) addressIds Set address ids
GroupsGetAddressesQuery	addressIds(java.util.List<java.lang.Integer> value) Set address ids
GroupsGetAddressesQuery	count(java.lang.Integer value) Number of community addresses to return.
protected java.util.List<java.lang.String>	essentialKeys() Get list of required parameter names
GroupsGetAddressesQuery	fields(Fields... value) fields Address fields
GroupsGetAddressesQuery	fields(java.util.List<Fields> value) Address fields
protected GroupsGetAddressesQuery	getThis() Get reference to this object
GroupsGetAddressesQuery	groupId(java.lang.Long value) ID or screen name of the community.
GroupsGetAddressesQuery	latitude(java.lang.Number value) Latitude of the user geo position.
GroupsGetAddressesQuery	longitude(java.lang.Number value) Longitude of the user geo position.
GroupsGetAddressesQuery	offset(java.lang.Integer value) Offset needed to return a specific subset of community addresses.

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

GroupsGetAddressesQuery

public GroupsGetAddressesQuery(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

GroupsGetAddressesQuery

public GroupsGetAddressesQuery(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

GroupsGetAddressesQuery

public GroupsGetAddressesQuery(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

GroupsGetAddressesQuery

public GroupsGetAddressesQuery(VkApiClient client,
                               ServiceActor actor)

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

Method Detail

groupId

public GroupsGetAddressesQuery groupId(java.lang.Long value)

ID or screen name of the community.

Parameters:

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

Returns:

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

latitude

public GroupsGetAddressesQuery latitude(java.lang.Number value)

Latitude of the user geo position.

Parameters:

value - value of "latitude" parameter. Maximum is 90. Minimum is -90.

Returns:

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

longitude

public GroupsGetAddressesQuery longitude(java.lang.Number value)

Longitude of the user geo position.

Parameters:

value - value of "longitude" parameter. Maximum is 180. Minimum is -180.

Returns:

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

offset

public GroupsGetAddressesQuery offset(java.lang.Integer value)

Offset needed to return a specific subset of community addresses.

Parameters:

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

Returns:

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

count

public GroupsGetAddressesQuery count(java.lang.Integer value)

Number of community addresses to return.

Parameters:

value - value of "count" parameter. Minimum is 0. By default 10.

Returns:

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

addressIds

public GroupsGetAddressesQuery addressIds(java.lang.Integer... value)

addressIds Set address ids

Parameters:

value - value of "address ids" parameter.

Returns:

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

addressIds

public GroupsGetAddressesQuery addressIds(java.util.List<java.lang.Integer> value)

Set address ids

Parameters:

value - value of "address ids" parameter.

Returns:

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

fields

public GroupsGetAddressesQuery fields(Fields... value)

fields Address fields

Parameters:

value - value of "fields" parameter.

Returns:

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

fields

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

Address fields

Parameters:

value - value of "fields" parameter.

Returns:

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

getThis

protected GroupsGetAddressesQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<GroupsGetAddressesQuery,GetAddressesResponse>

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<GroupsGetAddressesQuery,GetAddressesResponse>

Returns:

list of names