com.vk.api.sdk.queries.secure.SecureSetCounterQuery 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.secure;

import com.vk.api.sdk.client.AbstractSecureQueryBuilder;
import com.vk.api.sdk.client.VkApiClient;
import com.vk.api.sdk.client.actors.ServiceActor;
import com.vk.api.sdk.objects.annotations.ApiParam;
import com.vk.api.sdk.objects.base.responses.BoolResponse;

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

/**
 * Query for Secure.setCounter method
 */
public class SecureSetCounterQuery extends AbstractSecureQueryBuilder {
    /**
     * Creates a AbstractQueryBuilder instance that can be used to build service api request with various parameters
     *
     * @param client VK API client
     * @param actor actor with access token
     */
    public SecureSetCounterQuery(VkApiClient client, ServiceActor actor) {
        super(client, "secure.setCounter", BoolResponse.class);
        accessToken(actor.getAccessToken());
        clientSecret(actor.getClientSecret());
    }

    /**
     * Set user id
     *
     * @param value value of "user id" parameter. Minimum is 0. Entity - owner
     *
     * @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
     */
    @ApiParam("user_id")
    public SecureSetCounterQuery userId(Long value) {
        return unsafeParam("user_id", value);
    }

    /**
     * Counter value.
     *
     * @param value value of "counter" parameter.
     * @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
     */
    @ApiParam("counter")
    public SecureSetCounterQuery counter(Integer value) {
        return unsafeParam("counter", value);
    }

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

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

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

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

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