Package com.vk.api.sdk.queries.wall
Class WallGetCommentsQuery
- java.lang.Object
-
- com.vk.api.sdk.client.ApiRequest<R>
-
- com.vk.api.sdk.client.AbstractQueryBuilder<WallGetCommentsQuery,GetCommentsResponse>
-
- com.vk.api.sdk.queries.wall.WallGetCommentsQuery
-
public class WallGetCommentsQuery extends AbstractQueryBuilder<WallGetCommentsQuery,GetCommentsResponse>
Query for Wall.getComments method
-
-
Constructor Summary
Constructors Constructor Description WallGetCommentsQuery(VkApiClient client, ServiceActor actor)Creates a AbstractQueryBuilder instance that can be used to build api request with various parametersWallGetCommentsQuery(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 WallGetCommentsQuerycommentId(java.lang.Integer value)Comment ID.WallGetCommentsQuerycount(java.lang.Integer value)Number of comments to return (maximum 100).protected java.util.List<java.lang.String>essentialKeys()Get list of required parameter namesWallGetCommentsQueryextended(java.lang.Boolean value)Set extendedWallGetCommentsQueryfields(UserGroupFields... value)fields Set fieldsWallGetCommentsQueryfields(java.util.List<UserGroupFields> value)Set fieldsprotected WallGetCommentsQuerygetThis()Get reference to this objectWallGetCommentsQueryneedLikes(java.lang.Boolean value)'1' — to return the 'likes' field, '0' — not to return the 'likes' field (default)WallGetCommentsQueryoffset(java.lang.Integer value)Offset needed to return a specific subset of comments.WallGetCommentsQueryownerId(java.lang.Integer value)User ID or community ID.WallGetCommentsQuerypostId(java.lang.Integer value)Post ID.WallGetCommentsQuerypreviewLength(java.lang.Integer value)Number of characters at which to truncate comments when previewed.WallGetCommentsQuerysort(GetCommentsSort value)Sort order: 'asc' — chronological, 'desc' — reverse chronologicalWallGetCommentsQuerystartCommentId(java.lang.Integer value)Set start comment idWallGetCommentsQuerythreadItemsCount(java.lang.Integer value)Count items in threads.-
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
-
WallGetCommentsQuery
public WallGetCommentsQuery(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
-
WallGetCommentsQuery
public WallGetCommentsQuery(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
-
ownerId
public WallGetCommentsQuery ownerId(java.lang.Integer value)
User ID or community ID. Use a negative value to designate a community ID.- Parameters:
value- value of "owner id" parameter.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
postId
public WallGetCommentsQuery postId(java.lang.Integer value)
Post ID.- Parameters:
value- value of "post id" parameter. Minimum is 0.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
needLikes
public WallGetCommentsQuery needLikes(java.lang.Boolean value)
'1' — to return the 'likes' field, '0' — not to return the 'likes' field (default)- Parameters:
value- value of "need likes" parameter.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
startCommentId
public WallGetCommentsQuery startCommentId(java.lang.Integer value)
Set start comment id- Parameters:
value- value of "start comment id" parameter. Minimum is 0.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
offset
public WallGetCommentsQuery offset(java.lang.Integer value)
Offset needed to return a specific subset of comments.- Parameters:
value- value of "offset" parameter.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
count
public WallGetCommentsQuery count(java.lang.Integer value)
Number of comments to return (maximum 100).- Parameters:
value- value of "count" parameter. Minimum is 0.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
sort
public WallGetCommentsQuery sort(GetCommentsSort value)
Sort order: 'asc' — chronological, 'desc' — reverse chronological- Parameters:
value- value of "sort" parameter.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
previewLength
public WallGetCommentsQuery previewLength(java.lang.Integer value)
Number of characters at which to truncate comments when previewed. By default, '90'. Specify '0' if you do not want to truncate comments.- Parameters:
value- value of "preview length" parameter. Minimum is 0.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
extended
public WallGetCommentsQuery extended(java.lang.Boolean value)
Set extended- Parameters:
value- value of "extended" parameter.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
commentId
public WallGetCommentsQuery commentId(java.lang.Integer value)
Comment ID.- Parameters:
value- value of "comment id" parameter. Minimum is 0.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
threadItemsCount
public WallGetCommentsQuery threadItemsCount(java.lang.Integer value)
Count items in threads.- Parameters:
value- value of "thread items count" parameter. Maximum is 10. Minimum is 0. By default 0.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
fields
public WallGetCommentsQuery fields(UserGroupFields... value)
fields Set fields- Parameters:
value- value of "fields" parameter.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
fields
public WallGetCommentsQuery fields(java.util.List<UserGroupFields> value)
Set fields- Parameters:
value- value of "fields" parameter.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
getThis
protected WallGetCommentsQuery getThis()
Description copied from class:AbstractQueryBuilderGet reference to this object- Specified by:
getThisin classAbstractQueryBuilder<WallGetCommentsQuery,GetCommentsResponse>- 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<WallGetCommentsQuery,GetCommentsResponse>- Returns:
- list of names
-
-