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

Class StoriesGetByIdQuery

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<StoriesGetByIdQuery,GetByIdResponse>

com.vk.api.sdk.queries.stories.StoriesGetByIdQuery

public class StoriesGetByIdQuery
extends AbstractQueryBuilder<StoriesGetByIdQuery,GetByIdResponse>

Query for Stories.getById method

Constructor Summary

Constructors

Constructor	Description
StoriesGetByIdQuery(VkApiClient client, GroupActor actor, java.lang.String... stories)	Creates a AbstractQueryBuilder instance that can be used to build api request with various parameters
StoriesGetByIdQuery(VkApiClient client, GroupActor actor, java.util.List<java.lang.String> stories)	Creates a AbstractQueryBuilder instance that can be used to build api request with various parameters
StoriesGetByIdQuery(VkApiClient client, UserActor actor, java.lang.String... stories)	Creates a AbstractQueryBuilder instance that can be used to build api request with various parameters
StoriesGetByIdQuery(VkApiClient client, UserActor actor, java.util.List<java.lang.String> stories)	Creates a AbstractQueryBuilder instance that can be used to build api request with various parameters

Method Summary

Modifier and Type	Method	Description
protected java.util.List<java.lang.String>	essentialKeys()	Get list of required parameter names
StoriesGetByIdQuery	extended(java.lang.Boolean value)	'1' — to return additional fields for users and communities.
StoriesGetByIdQuery	fields(UserGroupFields... value)	fields Additional fields to return
StoriesGetByIdQuery	fields(java.util.List<UserGroupFields> value)	Additional fields to return
protected StoriesGetByIdQuery	getThis()	Get reference to this object
protected StoriesGetByIdQuery	stories(java.lang.String... value)	stories Stories IDs separated by commas.
protected StoriesGetByIdQuery	stories(java.util.List<java.lang.String> value)	Stories IDs separated by commas.

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

StoriesGetByIdQuery

public StoriesGetByIdQuery(VkApiClient client,
                           UserActor actor,
                           java.lang.String... stories)

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

stories - value of "stories" parameter.

StoriesGetByIdQuery

public StoriesGetByIdQuery(VkApiClient client,
                           UserActor actor,
                           java.util.List<java.lang.String> stories)

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

stories - value of "stories" parameter.

StoriesGetByIdQuery

public StoriesGetByIdQuery(VkApiClient client,
                           GroupActor actor,
                           java.lang.String... stories)

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

stories - value of "stories" parameter.

StoriesGetByIdQuery

public StoriesGetByIdQuery(VkApiClient client,
                           GroupActor actor,
                           java.util.List<java.lang.String> stories)

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

stories - value of "stories" parameter.

Method Detail

extended

public StoriesGetByIdQuery extended(java.lang.Boolean value)

'1' — to return additional fields for users and communities. Default value is 0.

Parameters:

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

Returns:

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

stories

protected StoriesGetByIdQuery stories(java.lang.String... value)

stories Stories IDs separated by commas. Use format {owner_id}+'_'+{story_id}, for example, 12345_54331.

Parameters:

value - value of "stories" parameter.

Returns:

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

stories

protected StoriesGetByIdQuery stories(java.util.List<java.lang.String> value)

Stories IDs separated by commas. Use format {owner_id}+'_'+{story_id}, for example, 12345_54331.

Parameters:

value - value of "stories" parameter.

Returns:

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

fields

public StoriesGetByIdQuery fields(UserGroupFields... value)

fields Additional fields to return

Parameters:

value - value of "fields" parameter.

Returns:

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

fields

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

Additional fields to return

Parameters:

value - value of "fields" parameter.

Returns:

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

getThis

protected StoriesGetByIdQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<StoriesGetByIdQuery,GetByIdResponse>

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<StoriesGetByIdQuery,GetByIdResponse>

Returns:

list of names