Package com.vk.api.sdk.queries.newsfeed
Class NewsfeedSearchQuery
- java.lang.Object
-
- com.vk.api.sdk.client.ApiRequest<R>
-
- com.vk.api.sdk.client.AbstractQueryBuilder<NewsfeedSearchQuery,SearchResponse>
-
- com.vk.api.sdk.queries.newsfeed.NewsfeedSearchQuery
-
public class NewsfeedSearchQuery extends AbstractQueryBuilder<NewsfeedSearchQuery,SearchResponse>
Query for Newsfeed.search method
-
-
Constructor Summary
Constructors Constructor Description NewsfeedSearchQuery(VkApiClient client, ServiceActor actor)Creates a AbstractQueryBuilder instance that can be used to build api request with various parametersNewsfeedSearchQuery(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 NewsfeedSearchQuerycount(java.lang.Integer value)Number of posts to return.NewsfeedSearchQueryendTime(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 namesNewsfeedSearchQueryextended(java.lang.Boolean value)'1' — to return additional information about the user or community that placed the post.NewsfeedSearchQueryfields(UserGroupFields... value)fields Additional fields of [vk.com/dev/fields|profiles] and [vk.com/dev/fields_groups|communities] to return.NewsfeedSearchQueryfields(java.util.List<UserGroupFields> value)Additional fields of [vk.com/dev/fields|profiles] and [vk.com/dev/fields_groups|communities] to return.protected NewsfeedSearchQuerygetThis()Get reference to this objectNewsfeedSearchQuerylatitude(java.lang.Number value)Geographical latitude point (in degrees, -90 to 90) within which to search.NewsfeedSearchQuerylongitude(java.lang.Number value)Geographical longitude point (in degrees, -180 to 180) within which to search.NewsfeedSearchQueryq(java.lang.String value)Search query string (e.g., 'New Year').NewsfeedSearchQuerystartFrom(java.lang.String value)Set start fromNewsfeedSearchQuerystartTime(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
-
NewsfeedSearchQuery
public NewsfeedSearchQuery(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
-
NewsfeedSearchQuery
public NewsfeedSearchQuery(VkApiClient client, ServiceActor 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
-
q
public NewsfeedSearchQuery q(java.lang.String value)
Search query string (e.g., 'New Year').- Parameters:
value- value of "q" parameter.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
extended
public NewsfeedSearchQuery extended(java.lang.Boolean value)
'1' — to return additional information about the user or community that placed the post.- Parameters:
value- value of "extended" parameter.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
count
public NewsfeedSearchQuery count(java.lang.Integer value)
Number of posts to return.- Parameters:
value- value of "count" parameter. Maximum is 200. Minimum is 0. By default 30.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
latitude
public NewsfeedSearchQuery latitude(java.lang.Number value)
Geographical latitude point (in degrees, -90 to 90) within which to search.- Parameters:
value- value of "latitude" parameter.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
longitude
public NewsfeedSearchQuery longitude(java.lang.Number value)
Geographical longitude point (in degrees, -180 to 180) within which to search.- Parameters:
value- value of "longitude" parameter.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
startTime
public NewsfeedSearchQuery 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 NewsfeedSearchQuery 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.
-
startFrom
public NewsfeedSearchQuery startFrom(java.lang.String value)
Set start from- Parameters:
value- value of "start from" parameter.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
fields
public NewsfeedSearchQuery 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 NewsfeedSearchQuery 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 NewsfeedSearchQuery getThis()
Description copied from class:AbstractQueryBuilderGet reference to this object- Specified by:
getThisin classAbstractQueryBuilder<NewsfeedSearchQuery,SearchResponse>- 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<NewsfeedSearchQuery,SearchResponse>- Returns:
- list of names
-
-