com.vk.api.sdk.queries.wall

Class WallEditQuery

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<WallEditQuery,OkResponse>

com.vk.api.sdk.queries.wall.WallEditQuery

public class WallEditQuery
extends AbstractQueryBuilder<WallEditQuery,OkResponse>

Query for Wall.edit method

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
WallEditQuery	attachments(java.util.List<java.lang.String> value) (Required if "message" is not set.)
WallEditQuery	attachments(java.lang.String... value) (Required if "message" is not set.)
protected java.util.List<java.lang.String>	essentialKeys() Get list of required parameter names
WallEditQuery	friendsOnly(java.lang.Boolean value) (Applies only when editing a scheduled post.)
protected WallEditQuery	getThis() Get reference to this object
WallEditQuery	lat(java.lang.Float value) Geographical latitude of the check-in, in degrees (from -90 to 90).
WallEditQuery	lng(java.lang.Float value) Geographical longitude of the check-in, in degrees (from -180 to 180).
WallEditQuery	markAsAds(java.lang.Boolean value) Set mark as ads
WallEditQuery	message(java.lang.String value) (Required if "attachments" is not set.)
WallEditQuery	ownerId(java.lang.Integer value) User ID or community ID.
WallEditQuery	placeId(java.lang.Integer value) ID of the location where the user was tagged.
protected WallEditQuery	postId(int value) Post ID.
WallEditQuery	publishDate(java.lang.Integer value) (Applies only to a scheduled post.)
WallEditQuery	services(java.lang.String value) (Applies only to a scheduled post.)
WallEditQuery	signed(java.lang.Boolean value) (Applies only to a post that was created "as community" on a community wall

Methods inherited from class com.vk.api.sdk.client.AbstractQueryBuilder

accessToken, build, captchaKey, captchaSid, clientSecret, confirm, getBody, getMethod, lang, 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, getResponseClass, getUrl

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WallEditQuery

public WallEditQuery(VkApiClient client,
                     UserActor actor,
                     int postId)

Creates a AbstractQueryBuilder instance that can be used to build api request with various parameters

Parameters:

client - VK API client

actor - actor with access token

postId - value of "post id" parameter. Minimum is 0.

Method Detail

ownerId

public WallEditQuery 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 AbstractQueryBuilder object to fulfill the "Builder" pattern.

postId

protected WallEditQuery postId(int value)

Post ID.

Parameters:

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

Returns:

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

friendsOnly

public WallEditQuery friendsOnly(java.lang.Boolean value)

(Applies only when editing a scheduled post.) Post will be available to friends only

Parameters:

value - value of "friends only" parameter.

Returns:

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

message

public WallEditQuery message(java.lang.String value)

(Required if "attachments" is not set.) Text of the post.

Parameters:

value - value of "message" parameter.

Returns:

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

attachments

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

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

Example: photo100172_166443618,photo66748_265827614 May contain a link to an external page to include in the post. Example:

photo66748_265827614,http://habrahabr.ru

NOTE: If more than one link is being attached, an error is thrown.

Parameters:

value - value of "attachments" parameter.

Returns:

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

attachments

public WallEditQuery 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""owner_id"_"media_id" ""type"" - Type of media attachment: "photo" - photo "video" - video "audio" - audio "doc" - document ""owner_id"" - ID of the media application owner. ""media_id"" - Media application ID.

Example: photo100172_166443618,photo66748_265827614 May contain a link to an external page to include in the post. Example:

photo66748_265827614,http://habrahabr.ru

NOTE: If more than one link is being attached, an error is thrown.

Parameters:

value - value of "attachments" parameter.

Returns:

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

services

public WallEditQuery services(java.lang.String value)

(Applies only to a scheduled post.) List of services or websites where status will be updated, if the user has so requested. Sample values: "twitter", "facebook".

Parameters:

value - value of "services" parameter.

Returns:

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

signed

public WallEditQuery signed(java.lang.Boolean value)

(Applies only to a post that was created "as community" on a community wall.) "1" - to add the signature of the user who created the post

Parameters:

value - value of "signed" parameter.

Returns:

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

publishDate

public WallEditQuery publishDate(java.lang.Integer value)

(Applies only to a scheduled post.) Publication date (in Unix time). If used, posting will be delayed until the set time.

Parameters:

value - value of "publish date" parameter. Minimum is 0.

Returns:

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

lat

public WallEditQuery lat(java.lang.Float value)

Geographical latitude of the check-in, in degrees (from -90 to 90).

Parameters:

value - value of "lat" parameter.

Returns:

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

lng

public WallEditQuery lng(java.lang.Float value)

Geographical longitude of the check-in, in degrees (from -180 to 180).

Parameters:

value - value of "long" parameter.

Returns:

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

placeId

public WallEditQuery placeId(java.lang.Integer value)

ID of the location where the user was tagged.

Parameters:

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

Returns:

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

markAsAds

public WallEditQuery markAsAds(java.lang.Boolean value)

Set mark as ads

Parameters:

value - value of "mark as ads" parameter.

Returns:

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

getThis

protected WallEditQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<WallEditQuery,OkResponse>

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<WallEditQuery,OkResponse>

Returns:

list of names