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

Class StoriesGetViewersQueryWithExtended

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<StoriesGetViewersQueryWithExtended,GetViewersExtendedResponse>

com.vk.api.sdk.queries.stories.StoriesGetViewersQueryWithExtended

public class StoriesGetViewersQueryWithExtended
extends AbstractQueryBuilder<StoriesGetViewersQueryWithExtended,GetViewersExtendedResponse>

Query for Stories.getViewers method

Constructor Summary

Constructors

Constructor	Description
StoriesGetViewersQueryWithExtended(VkApiClient client, GroupActor actor, int ownerId, int storyId)	Creates a AbstractQueryBuilder instance that can be used to build api request with various parameters
StoriesGetViewersQueryWithExtended(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
StoriesGetViewersQueryWithExtended	count(java.lang.Integer value)	Maximum number of results.
protected java.util.List<java.lang.String>	essentialKeys()	Get list of required parameter names
protected StoriesGetViewersQueryWithExtended	extended(java.lang.Boolean value)	'1' — to return detailed information about photos
protected StoriesGetViewersQueryWithExtended	getThis()	Get reference to this object
StoriesGetViewersQueryWithExtended	offset(java.lang.Integer value)	Offset needed to return a specific subset of results.
protected StoriesGetViewersQueryWithExtended	ownerId(int value)	Story owner ID.
protected StoriesGetViewersQueryWithExtended	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

StoriesGetViewersQueryWithExtended

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

StoriesGetViewersQueryWithExtended

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

protected StoriesGetViewersQueryWithExtended 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 StoriesGetViewersQueryWithExtended getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<StoriesGetViewersQueryWithExtended,GetViewersExtendedResponse>

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<StoriesGetViewersQueryWithExtended,GetViewersExtendedResponse>

Returns:

list of names