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

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

/**
 * Query for Database.getSchools method
 */
public class DatabaseGetSchoolsQuery 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
     * @param cityId value of "city id" parameter. Minimum is 0.
     */
    public DatabaseGetSchoolsQuery(VkApiClient client, ServiceActor actor, Integer cityId) {
        super(client, "database.getSchools", GetSchoolsResponse.class);
        accessToken(actor.getAccessToken());
        clientSecret(actor.getClientSecret());
        cityId(cityId);
    }

    /**
     * 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 DatabaseGetSchoolsQuery(VkApiClient client, ServiceActor actor) {
        super(client, "database.getSchools", GetSchoolsResponse.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
     * @param cityId value of "city id" parameter. Minimum is 0.
     */
    public DatabaseGetSchoolsQuery(VkApiClient client, UserActor actor, Integer cityId) {
        super(client, "database.getSchools", GetSchoolsResponse.class);
        accessToken(actor.getAccessToken());
        cityId(cityId);
    }

    /**
     * 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 DatabaseGetSchoolsQuery(VkApiClient client, UserActor actor) {
        super(client, "database.getSchools", GetSchoolsResponse.class);
        accessToken(actor.getAccessToken());
    }

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

    /**
     * City ID.
     *
     * @param value value of "city id" parameter. Minimum is 0.
     * @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
     */
    @ApiParam("city_id")
    public DatabaseGetSchoolsQuery cityId(Integer value) {
        return unsafeParam("city_id", value);
    }

    /**
     * Offset needed to return a specific subset of schools.
     *
     * @param value value of "offset" parameter. Minimum is 0.
     * @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
     */
    @ApiParam("offset")
    public DatabaseGetSchoolsQuery offset(Integer value) {
        return unsafeParam("offset", value);
    }

    /**
     * Number of schools to return.
     *
     * @param value value of "count" parameter. Maximum is 10000. Minimum is 0. By default 100.
     * @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
     */
    @ApiParam("count")
    public DatabaseGetSchoolsQuery count(Integer value) {
        return unsafeParam("count", value);
    }

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

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