com.vk.api.sdk.queries.database.DatabaseGetCitiesByIdQuery 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.database;

import com.vk.api.sdk.client.AbstractQueryBuilder;
import com.vk.api.sdk.client.Utils;
import com.vk.api.sdk.client.VkApiClient;
import com.vk.api.sdk.client.actors.ServiceActor;
import com.vk.api.sdk.client.actors.UserActor;
import com.vk.api.sdk.objects.annotations.ApiParam;
import com.vk.api.sdk.objects.database.responses.GetCitiesByIdResponse;

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

/**
 * Query for Database.getCitiesById method
 */
public class DatabaseGetCitiesByIdQuery extends AbstractQueryBuilder> {
    /**
     * 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 DatabaseGetCitiesByIdQuery(VkApiClient client, ServiceActor actor) {
        super(client, "database.getCitiesById", Utils.buildParametrizedType(List.class, GetCitiesByIdResponse.class));
        accessToken(actor.getAccessToken());
        clientSecret(actor.getClientSecret());
    }

    /**
     * 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 DatabaseGetCitiesByIdQuery(VkApiClient client, UserActor actor) {
        super(client, "database.getCitiesById", Utils.buildParametrizedType(List.class, GetCitiesByIdResponse.class));
        accessToken(actor.getAccessToken());
    }

    /**
     * cityIds
     * City IDs.
     *
     * @param value value of "city ids" parameter.
     * @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
     */
    @ApiParam("city_ids")
    public DatabaseGetCitiesByIdQuery cityIds(Integer... value) {
        return unsafeParam("city_ids", value);
    }

    /**
     * City IDs.
     *
     * @param value value of "city ids" parameter.
     * @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
     */
    @ApiParam("city_ids")
    public DatabaseGetCitiesByIdQuery cityIds(List value) {
        return unsafeParam("city_ids", value);
    }

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

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