com.vk.api.sdk.queries.appwidgets.AppWidgetsGetGroupImagesQuery Maven / Gradle / Ivy

Go to download
// Autogenerated from vk-api-schema. Please don't edit it manually.
package com.vk.api.sdk.queries.appwidgets;

import com.vk.api.sdk.client.AbstractQueryBuilder;
import com.vk.api.sdk.client.VkApiClient;
import com.vk.api.sdk.client.actors.GroupActor;
import com.vk.api.sdk.objects.appwidgets.GetGroupImagesImageType;
import com.vk.api.sdk.objects.appwidgets.responses.GetGroupImagesResponse;
import java.util.Arrays;
import java.util.List;

/**
 * Query for AppWidgets.getGroupImages method
 */
public class AppWidgetsGetGroupImagesQuery extends AbstractQueryBuilder {
    /**
     * Creates a AbstractQueryBuilder instance that can be used to build api request with various parameters
     *
     * @param client VK API client
     * @param actor actor with access token
     */
    public AppWidgetsGetGroupImagesQuery(VkApiClient client, GroupActor actor) {
        super(client, "appWidgets.getGroupImages", GetGroupImagesResponse.class);
        accessToken(actor.getAccessToken());
    }

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

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

    /**
     * Set image type
     *
     * @param value value of "image type" parameter.
     * @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
     */
    public AppWidgetsGetGroupImagesQuery imageType(GetGroupImagesImageType value) {
        return unsafeParam("image_type", value);
    }

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

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