com.vk.api.sdk.queries.database.DatabaseGetFacultiesQuery Maven / Gradle / Ivy

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.GetFacultiesResponse;
import java.util.Arrays;
import java.util.List;

/**
 * Query for Database.getFaculties method
 */
public class DatabaseGetFacultiesQuery 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 universityId value of "university id" parameter. Minimum is 0.
     */
    public DatabaseGetFacultiesQuery(VkApiClient client, UserActor actor, Integer universityId) {
        super(client, "database.getFaculties", GetFacultiesResponse.class);
        accessToken(actor.getAccessToken());
        universityId(universityId);
    }

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

    /**
     * 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 universityId value of "university id" parameter. Minimum is 0.
     */
    public DatabaseGetFacultiesQuery(VkApiClient client, ServiceActor actor, Integer universityId) {
        super(client, "database.getFaculties", GetFacultiesResponse.class);
        accessToken(actor.getAccessToken());
        clientSecret(actor.getClientSecret());
        universityId(universityId);
    }

    /**
     * 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 DatabaseGetFacultiesQuery(VkApiClient client, ServiceActor actor) {
        super(client, "database.getFaculties", GetFacultiesResponse.class);
        accessToken(actor.getAccessToken());
        clientSecret(actor.getClientSecret());
    }

    /**
     * University ID.
     *
     * @param value value of "university id" parameter. Minimum is 0.
     * @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
     */
    @ApiParam("university_id")
    public DatabaseGetFacultiesQuery universityId(Integer value) {
        return unsafeParam("university_id", value);
    }

    /**
     * Offset needed to return a specific subset of faculties.
     *
     * @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 DatabaseGetFacultiesQuery offset(Integer value) {
        return unsafeParam("offset", value);
    }

    /**
     * Number of faculties 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 DatabaseGetFacultiesQuery count(Integer value) {
        return unsafeParam("count", value);
    }

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

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