com.vk.api.sdk.queries.stories

Class StoriesGetByIdQueryWithExtended

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<StoriesGetByIdQueryWithExtended,GetByIdExtendedResponse>

com.vk.api.sdk.queries.stories.StoriesGetByIdQueryWithExtended

public class StoriesGetByIdQueryWithExtended
extends AbstractQueryBuilder<StoriesGetByIdQueryWithExtended,GetByIdExtendedResponse>

Query for Stories.getById method

Constructor Summary

Constructors

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

Method Summary

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

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

StoriesGetByIdQueryWithExtended

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

Creates a AbstractQueryBuilder instance that can be used to build group api request with various parameters

Parameters:

client - VK API client

actor - actor with access token

stories - value of "stories" parameter.

StoriesGetByIdQueryWithExtended

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

Creates a AbstractQueryBuilder instance that can be used to build group api request with various parameters

Parameters:

client - VK API client

actor - actor with access token

stories - value of "stories" parameter.

StoriesGetByIdQueryWithExtended

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

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

stories - value of "stories" parameter.

StoriesGetByIdQueryWithExtended

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

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

stories - value of "stories" parameter.

Method Detail

extended

protected StoriesGetByIdQueryWithExtended 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

public StoriesGetByIdQueryWithExtended 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

public StoriesGetByIdQueryWithExtended 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 StoriesGetByIdQueryWithExtended 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 StoriesGetByIdQueryWithExtended 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 StoriesGetByIdQueryWithExtended getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<StoriesGetByIdQueryWithExtended,GetByIdExtendedResponse>

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<StoriesGetByIdQueryWithExtended,GetByIdExtendedResponse>

Returns:

list of names