Package 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,GetResponse>
-
- com.vk.api.sdk.queries.newsfeed.NewsfeedGetQuery
-
public class NewsfeedGetQuery extends AbstractQueryBuilder<NewsfeedGetQuery,GetResponse>
Query for Newsfeed.get method
-
-
Constructor Summary
Constructors Constructor Description NewsfeedGetQuery(VkApiClient client, UserActor actor)Creates a AbstractQueryBuilder instance that can be used to build api request with various parameters
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description NewsfeedGetQuerycount(java.lang.Integer value)Number of news items to return (default 50, maximum 100).NewsfeedGetQueryendTime(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 namesNewsfeedGetQueryfields(UserGroupFields... value)fields Additional fields of [vk.com/dev/fields|profiles] and [vk.com/dev/fields_groups|communities] to return.NewsfeedGetQueryfields(java.util.List<UserGroupFields> value)Additional fields of [vk.com/dev/fields|profiles] and [vk.com/dev/fields_groups|communities] to return.NewsfeedGetQueryfilters(Filters... value)filters Filters to apply: 'post' — new wall posts, 'photo' — new photos, 'photo_tag' — new photo tags, 'wall_photo' — new wall photos, 'friend' — new friendsNewsfeedGetQueryfilters(java.util.List<Filters> value)Filters to apply: 'post' — new wall posts, 'photo' — new photos, 'photo_tag' — new photo tags, 'wall_photo' — new wall photos, 'friend' — new friendsprotected NewsfeedGetQuerygetThis()Get reference to this objectNewsfeedGetQuerymaxPhotos(java.lang.Integer value)Maximum number of photos to return.NewsfeedGetQueryreturnBanned(java.lang.Boolean value)'1' — to return news items from banned sourcesNewsfeedGetQuerysection(java.lang.String value)Set sectionNewsfeedGetQuerysourceIds(java.lang.String value)Sources to obtain news from, separated by commas.NewsfeedGetQuerystartFrom(java.lang.String value)Identifier required to get the next page of results.NewsfeedGetQuerystartTime(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, 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
-
-
-
-
Constructor Detail
-
NewsfeedGetQuery
public NewsfeedGetQuery(VkApiClient client, UserActor actor)
Creates a AbstractQueryBuilder instance that can be used to build api request with various parameters- Parameters:
client- VK API clientactor- 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
AbstractQueryBuilderobject 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
AbstractQueryBuilderobject 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
AbstractQueryBuilderobject 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
AbstractQueryBuilderobject 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
AbstractQueryBuilderobject 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
AbstractQueryBuilderobject 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
AbstractQueryBuilderobject 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
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
filters
public NewsfeedGetQuery filters(Filters... 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
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
filters
public NewsfeedGetQuery filters(java.util.List<Filters> 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
AbstractQueryBuilderobject 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
AbstractQueryBuilderobject 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
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
getThis
protected NewsfeedGetQuery getThis()
Description copied from class:AbstractQueryBuilderGet reference to this object- Specified by:
getThisin classAbstractQueryBuilder<NewsfeedGetQuery,GetResponse>- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
essentialKeys
protected java.util.List<java.lang.String> essentialKeys()
Description copied from class:AbstractQueryBuilderGet list of required parameter names- Specified by:
essentialKeysin classAbstractQueryBuilder<NewsfeedGetQuery,GetResponse>- Returns:
- list of names
-
-