com.vk.api.sdk.queries.photos

Class PhotosCreateCommentQuery

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<PhotosCreateCommentQuery,java.lang.Integer>

com.vk.api.sdk.queries.photos.PhotosCreateCommentQuery

public class PhotosCreateCommentQuery
extends AbstractQueryBuilder<PhotosCreateCommentQuery,java.lang.Integer>

Query for Photos.createComment method

Constructor Summary

Constructors

Constructor and Description
PhotosCreateCommentQuery(VkApiClient client, UserActor actor) Creates a AbstractQueryBuilder instance that can be used to build user api request with various parameters
PhotosCreateCommentQuery(VkApiClient client, UserActor actor, java.lang.Integer photoId) Creates a AbstractQueryBuilder instance that can be used to build user api request with various parameters

Method Summary

Modifier and Type	Method and Description
PhotosCreateCommentQuery	accessKey(java.lang.String value) Set access key
PhotosCreateCommentQuery	attachments(java.util.List<java.lang.String> value) (Required if 'message' is not set.)
PhotosCreateCommentQuery	attachments(java.lang.String... value) attachments (Required if 'message' is not set.)
protected java.util.List<java.lang.String>	essentialKeys() Get list of required parameter names
PhotosCreateCommentQuery	fromGroup(java.lang.Boolean value) '1' - to post a comment from the community
protected PhotosCreateCommentQuery	getThis() Get reference to this object
PhotosCreateCommentQuery	guid(java.lang.String value) Set guid
PhotosCreateCommentQuery	message(java.lang.String value) Comment text.
PhotosCreateCommentQuery	ownerId(java.lang.Long value) ID of the user or community that owns the photo.
PhotosCreateCommentQuery	photoId(java.lang.Integer value) Photo ID.
PhotosCreateCommentQuery	replyToComment(java.lang.Integer value) Set reply to comment
PhotosCreateCommentQuery	stickerId(java.lang.Integer value) Set sticker id

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

PhotosCreateCommentQuery

public PhotosCreateCommentQuery(VkApiClient client,
                                UserActor actor,
                                java.lang.Integer photoId)

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

photoId - value of "photo id" parameter.

PhotosCreateCommentQuery

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

ownerId

public PhotosCreateCommentQuery ownerId(java.lang.Long value)

ID of the user or community that owns the photo.

Parameters:

value - value of "owner id" parameter. Entity - owner

Returns:

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

photoId

public PhotosCreateCommentQuery photoId(java.lang.Integer value)

Photo ID.

Parameters:

value - value of "photo id" parameter.

Returns:

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

message

public PhotosCreateCommentQuery message(java.lang.String value)

Comment text.

Parameters:

value - value of "message" parameter.

Returns:

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

fromGroup

public PhotosCreateCommentQuery fromGroup(java.lang.Boolean value)

'1' - to post a comment from the community

Parameters:

value - value of "from group" parameter.

Returns:

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

replyToComment

public PhotosCreateCommentQuery replyToComment(java.lang.Integer value)

Set reply to comment

Parameters:

value - value of "reply to comment" parameter.

Returns:

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

stickerId

public PhotosCreateCommentQuery stickerId(java.lang.Integer value)

Set sticker id

Parameters:

value - value of "sticker id" parameter. Minimum is 0.

Returns:

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

accessKey

public PhotosCreateCommentQuery accessKey(java.lang.String value)

Set access key

Parameters:

value - value of "access key" parameter.

Returns:

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

guid

public PhotosCreateCommentQuery guid(java.lang.String value)

Set guid

Parameters:

value - value of "guid" parameter.

Returns:

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

attachments

public PhotosCreateCommentQuery attachments(java.lang.String... value)

attachments (Required if 'message' is not set.) List of objects attached to the post, in the following format: "_,_", ' - Type of media attachment: 'photo' - photo, 'video' - video, 'audio' - audio, 'doc' - document, '' - Media attachment owner ID. '' - Media attachment ID. Example: "photo100172_166443618,photo66748_265827614"

Parameters:

value - value of "attachments" parameter.

Returns:

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

attachments

public PhotosCreateCommentQuery attachments(java.util.List<java.lang.String> value)

(Required if 'message' is not set.) List of objects attached to the post, in the following format: "_,_", ' - Type of media attachment: 'photo' - photo, 'video' - video, 'audio' - audio, 'doc' - document, '' - Media attachment owner ID. '' - Media attachment ID. Example: "photo100172_166443618,photo66748_265827614"

Parameters:

value - value of "attachments" parameter.

Returns:

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

getThis

protected PhotosCreateCommentQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<PhotosCreateCommentQuery,java.lang.Integer>

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<PhotosCreateCommentQuery,java.lang.Integer>

Returns:

list of names