com.vk.api.sdk.queries.wall.WallEditQuery Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sdk Show documentation
Java library for VK API interaction, includes OAuth 2.0 authorization and API methods.
The newest version!
// Autogenerated from vk-api-schema. Please don't edit it manually.
package com.vk.api.sdk.queries.wall;

import com.vk.api.sdk.client.AbstractQueryBuilder;
import com.vk.api.sdk.client.VkApiClient;
import com.vk.api.sdk.client.actors.UserActor;
import com.vk.api.sdk.objects.annotations.ApiParam;
import com.vk.api.sdk.objects.wall.EditTopicId;
import com.vk.api.sdk.objects.wall.responses.EditResponse;

import java.util.Arrays;
import java.util.List;

/**
 * Query for Wall.edit method
 */
public class WallEditQuery extends AbstractQueryBuilder {
    /**
     * Creates a AbstractQueryBuilder instance that can be used to build user api request with various parameters
     *
     * @param client VK API client
     * @param actor actor with access token
     * @param postId value of "post id" parameter. Minimum is 0.
     */
    public WallEditQuery(VkApiClient client, UserActor actor, Integer postId) {
        super(client, "wall.edit", EditResponse.class);
        accessToken(actor.getAccessToken());
        postId(postId);
    }

    /**
     * Creates a AbstractQueryBuilder instance that can be used to build user api request with various parameters
     *
     * @param client VK API client
     * @param actor actor with access token
     */
    public WallEditQuery(VkApiClient client, UserActor actor) {
        super(client, "wall.edit", EditResponse.class);
        accessToken(actor.getAccessToken());
    }

    /**
     * User ID or community ID. Use a negative value to designate a community ID.
     *
     * @param value value of "owner id" parameter. Entity - owner
     *
     * @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
     */
    @ApiParam("owner_id")
    public WallEditQuery ownerId(Long value) {
        return unsafeParam("owner_id", value);
    }

    /**
     * Set post id
     *
     * @param value value of "post id" parameter. Minimum is 0.
     * @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
     */
    @ApiParam("post_id")
    public WallEditQuery postId(Integer value) {
        return unsafeParam("post_id", value);
    }

    /**
     * Set friends only
     *
     * @param value value of "friends only" parameter.
     * @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
     */
    @ApiParam("friends_only")
    public WallEditQuery friendsOnly(Boolean value) {
        return unsafeParam("friends_only", value);
    }

    /**
     * (Required if 'attachments' is not set.) Text of the post.
     *
     * @param value value of "message" parameter.
     * @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
     */
    @ApiParam("message")
    public WallEditQuery message(String value) {
        return unsafeParam("message", value);
    }

    /**
     * Set services
     *
     * @param value value of "services" parameter.
     * @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
     */
    @ApiParam("services")
    public WallEditQuery services(String value) {
        return unsafeParam("services", value);
    }

    /**
     * Set signed
     *
     * @param value value of "signed" parameter.
     * @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
     */
    @ApiParam("signed")
    public WallEditQuery signed(Boolean value) {
        return unsafeParam("signed", value);
    }

    /**
     * Set publish date
     *
     * @param value value of "publish date" parameter. Minimum is 0.
     * @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
     */
    @ApiParam("publish_date")
    public WallEditQuery publishDate(Integer value) {
        return unsafeParam("publish_date", value);
    }

    /**
     * Set lat
     *
     * @param value value of "lat" parameter.
     * @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
     */
    @ApiParam("lat")
    public WallEditQuery lat(Number value) {
        return unsafeParam("lat", value);
    }

    /**
     * Set long
     *
     * @param value value of "long" parameter.
     * @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
     */
    @ApiParam("long")
    public WallEditQuery lng(Number value) {
        return unsafeParam("long", value);
    }

    /**
     * Set place id
     *
     * @param value value of "place id" parameter. Minimum is 0.
     * @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
     */
    @ApiParam("place_id")
    public WallEditQuery placeId(Integer value) {
        return unsafeParam("place_id", value);
    }

    /**
     * Set mark as ads
     *
     * @param value value of "mark as ads" parameter.
     * @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
     */
    @ApiParam("mark_as_ads")
    public WallEditQuery markAsAds(Boolean value) {
        return unsafeParam("mark_as_ads", value);
    }

    /**
     * Set close comments
     *
     * @param value value of "close comments" parameter.
     * @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
     */
    @ApiParam("close_comments")
    public WallEditQuery closeComments(Boolean value) {
        return unsafeParam("close_comments", value);
    }

    /**
     * Set donut paid duration
     *
     * @param value value of "donut paid duration" parameter.
     * @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
     */
    @ApiParam("donut_paid_duration")
    public WallEditQuery donutPaidDuration(Integer value) {
        return unsafeParam("donut_paid_duration", value);
    }

    /**
     * Set poster bkg id
     *
     * @param value value of "poster bkg id" parameter. Minimum is 0.
     * @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
     */
    @ApiParam("poster_bkg_id")
    public WallEditQuery posterBkgId(Integer value) {
        return unsafeParam("poster_bkg_id", value);
    }

    /**
     * Set poster bkg owner id
     *
     * @param value value of "poster bkg owner id" parameter. Entity - owner
     *
     * @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
     */
    @ApiParam("poster_bkg_owner_id")
    public WallEditQuery posterBkgOwnerId(Long value) {
        return unsafeParam("poster_bkg_owner_id", value);
    }

    /**
     * Set poster bkg access hash
     *
     * @param value value of "poster bkg access hash" parameter.
     * @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
     */
    @ApiParam("poster_bkg_access_hash")
    public WallEditQuery posterBkgAccessHash(String value) {
        return unsafeParam("poster_bkg_access_hash", value);
    }

    /**
     * Set copyright
     *
     * @param value value of "copyright" parameter.
     * @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
     */
    @ApiParam("copyright")
    public WallEditQuery copyright(String value) {
        return unsafeParam("copyright", value);
    }

    /**
     * Topic ID. Allowed values can be obtained from newsfeed.getPostTopics method
     *
     * @param value value of "topic id" parameter. Minimum is 0.
     * @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
     */
    @ApiParam("topic_id")
    public WallEditQuery topicId(EditTopicId value) {
        return unsafeParam("topic_id", 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, '' - ID of the media application owner. '' - 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."
     *
     * @param value value of "attachments" parameter.
     * @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
     */
    @ApiParam("attachments")
    public WallEditQuery attachments(String... value) {
        return unsafeParam("attachments", 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, '' - ID of the media application owner. '' - 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."
     *
     * @param value value of "attachments" parameter.
     * @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
     */
    @ApiParam("attachments")
    public WallEditQuery attachments(List value) {
        return unsafeParam("attachments", value);
    }

    @Override
    protected WallEditQuery getThis() {
        return this;
    }

    @Override
    protected List essentialKeys() {
        return Arrays.asList("post_id", "access_token");
    }
}