com.vk.api.sdk.queries.newsfeed

Class NewsfeedGetQuery

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<NewsfeedGetQuery,GenericResponse>

com.vk.api.sdk.queries.newsfeed.NewsfeedGetQuery

public class NewsfeedGetQuery
extends AbstractQueryBuilder<NewsfeedGetQuery,GenericResponse>

Query for Newsfeed.get method

Constructor Summary

Constructors

Constructor and Description
NewsfeedGetQuery(VkApiClient client, UserActor actor) Creates a AbstractQueryBuilder instance that can be used to build user api request with various parameters

Method Summary

Modifier and Type	Method and Description
NewsfeedGetQuery	count(java.lang.Integer value) Number of news items to return (default 50, maximum 100).
NewsfeedGetQuery	endTime(java.lang.Integer value) Latest timestamp (in Unix time) of a news item to return.
protected java.util.List<java.lang.String>	essentialKeys() Get list of required parameter names
NewsfeedGetQuery	fields(java.util.List<UserGroupFields> value) Additional fields of [vk.com/dev/fields|profiles] and [vk.com/dev/fields_groups|communities] to return.
NewsfeedGetQuery	fields(UserGroupFields... value) fields Additional fields of [vk.com/dev/fields|profiles] and [vk.com/dev/fields_groups|communities] to return.
NewsfeedGetQuery	filters(java.util.List<NewsfeedItemType> value) Filters to apply: 'post' - new wall posts, 'photo' - new photos, 'photo_tag' - new photo tags, 'wall_photo' - new wall photos, 'friend' - new friends
NewsfeedGetQuery	filters(NewsfeedItemType... value) filters Filters to apply: 'post' - new wall posts, 'photo' - new photos, 'photo_tag' - new photo tags, 'wall_photo' - new wall photos, 'friend' - new friends
protected NewsfeedGetQuery	getThis() Get reference to this object
NewsfeedGetQuery	maxPhotos(java.lang.Integer value) Maximum number of photos to return.
NewsfeedGetQuery	returnBanned(java.lang.Boolean value) '1' - to return news items from banned sources
NewsfeedGetQuery	section(java.lang.String value) Set section
NewsfeedGetQuery	sourceIds(java.lang.String value) Sources to obtain news from, separated by commas.
NewsfeedGetQuery	startFrom(java.lang.String value) Identifier required to get the next page of results.
NewsfeedGetQuery	startTime(java.lang.Integer value) Earliest timestamp (in Unix time) of a news item to return.

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

NewsfeedGetQuery

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

Method Detail

returnBanned

public NewsfeedGetQuery returnBanned(java.lang.Boolean value)

'1' - to return news items from banned sources

Parameters:

value - value of "return banned" parameter.

Returns:

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

startTime

public NewsfeedGetQuery startTime(java.lang.Integer value)

Earliest timestamp (in Unix time) of a news item to return. By default, 24 hours ago.

Parameters:

value - value of "start time" parameter. Minimum is 0.

Returns:

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

endTime

public NewsfeedGetQuery endTime(java.lang.Integer value)

Latest timestamp (in Unix time) of a news item to return. By default, the current time.

Parameters:

value - value of "end time" parameter. Minimum is 0.

Returns:

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

maxPhotos

public NewsfeedGetQuery maxPhotos(java.lang.Integer value)

Maximum number of photos to return. By default, '5'.

Parameters:

value - value of "max photos" parameter. Minimum is 0.

Returns:

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

sourceIds

public NewsfeedGetQuery sourceIds(java.lang.String value)

Sources to obtain news from, separated by commas. User IDs can be specified in formats ' or 'u' , where ' is the user's friend ID. Community IDs can be specified in formats '-' or 'g' , where ' is the community ID. If the parameter is not set, all of the user's friends and communities are returned, except for banned sources, which can be obtained with the [vk.com/dev/newsfeed.getBanned|newsfeed.getBanned] method.

Parameters:

value - value of "source ids" parameter.

Returns:

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

startFrom

public NewsfeedGetQuery startFrom(java.lang.String value)

Identifier required to get the next page of results. Value for this parameter is returned in 'next_from' field in a reply.

Parameters:

value - value of "start from" parameter.

Returns:

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

count

public NewsfeedGetQuery count(java.lang.Integer value)

Number of news items to return (default 50, maximum 100). For auto feed, you can use the 'new_offset' parameter returned by this method.

Parameters:

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

Returns:

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

section

public NewsfeedGetQuery section(java.lang.String value)

Set section

Parameters:

value - value of "section" parameter.

Returns:

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

filters

public NewsfeedGetQuery filters(NewsfeedItemType... value)

filters Filters to apply: 'post' - new wall posts, 'photo' - new photos, 'photo_tag' - new photo tags, 'wall_photo' - new wall photos, 'friend' - new friends

Parameters:

value - value of "filters" parameter.

Returns:

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

filters

public NewsfeedGetQuery filters(java.util.List<NewsfeedItemType> value)

Filters to apply: 'post' - new wall posts, 'photo' - new photos, 'photo_tag' - new photo tags, 'wall_photo' - new wall photos, 'friend' - new friends

Parameters:

value - value of "filters" parameter.

Returns:

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

fields

public NewsfeedGetQuery fields(UserGroupFields... value)

fields Additional fields of [vk.com/dev/fields|profiles] and [vk.com/dev/fields_groups|communities] to return.

Parameters:

value - value of "fields" parameter.

Returns:

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

fields

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

Additional fields of [vk.com/dev/fields|profiles] and [vk.com/dev/fields_groups|communities] to return.

Parameters:

value - value of "fields" parameter.

Returns:

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

getThis

protected NewsfeedGetQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<NewsfeedGetQuery,GenericResponse>

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<NewsfeedGetQuery,GenericResponse>

Returns:

list of names