Package com.vk.api.sdk.queries.stories

Class StoriesGetViewersQuery

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<StoriesGetViewersQuery,GetViewersResponse>

com.vk.api.sdk.queries.stories.StoriesGetViewersQuery

public class StoriesGetViewersQuery
extends AbstractQueryBuilder<StoriesGetViewersQuery,GetViewersResponse>

Query for Stories.getViewers method

Constructor Summary

Constructors

Constructor	Description
StoriesGetViewersQuery(VkApiClient client, GroupActor actor, int ownerId, int storyId)	Creates a AbstractQueryBuilder instance that can be used to build api request with various parameters
StoriesGetViewersQuery(VkApiClient client, UserActor actor, int ownerId, int storyId)	Creates a AbstractQueryBuilder instance that can be used to build api request with various parameters

Method Summary

Modifier and Type	Method	Description
StoriesGetViewersQuery	count(java.lang.Integer value)	Maximum number of results.
protected java.util.List<java.lang.String>	essentialKeys()	Get list of required parameter names
StoriesGetViewersQuery	extended(java.lang.Boolean value)	'1' — to return detailed information about photos
protected StoriesGetViewersQuery	getThis()	Get reference to this object
StoriesGetViewersQuery	offset(java.lang.Integer value)	Offset needed to return a specific subset of results.
protected StoriesGetViewersQuery	ownerId(int value)	Story owner ID.
protected StoriesGetViewersQuery	storyId(int value)	Story 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

StoriesGetViewersQuery

public StoriesGetViewersQuery(VkApiClient client,
                              UserActor actor,
                              int ownerId,
                              int storyId)

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

ownerId - value of "owner id" parameter.

storyId - value of "story id" parameter. Minimum is 0.

StoriesGetViewersQuery

public StoriesGetViewersQuery(VkApiClient client,
                              GroupActor actor,
                              int ownerId,
                              int storyId)

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

ownerId - value of "owner id" parameter.

storyId - value of "story id" parameter. Minimum is 0.

Method Detail

ownerId

protected StoriesGetViewersQuery ownerId(int value)

Story owner ID.

Parameters:

value - value of "owner id" parameter.

Returns:

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

storyId

protected StoriesGetViewersQuery storyId(int value)

Story ID.

Parameters:

value - value of "story id" parameter. Minimum is 0.

Returns:

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

count

public StoriesGetViewersQuery count(java.lang.Integer value)

Maximum number of results.

Parameters:

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

Returns:

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

offset

public StoriesGetViewersQuery offset(java.lang.Integer value)

Offset needed to return a specific subset of results.

Parameters:

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

Returns:

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

extended

public StoriesGetViewersQuery extended(java.lang.Boolean value)

'1' — to return detailed information about photos

Parameters:

value - value of "extended" parameter. By default 0.

Returns:

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

getThis

protected StoriesGetViewersQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<StoriesGetViewersQuery,GetViewersResponse>

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<StoriesGetViewersQuery,GetViewersResponse>

Returns:

list of names