com.vk.api.sdk.queries.newsfeed.NewsfeedGetListsQuery 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.newsfeed;

import com.vk.api.sdk.client.AbstractQueryBuilder;
import com.vk.api.sdk.client.VkApiClient;
import com.vk.api.sdk.client.actors.UserActor;
import com.vk.api.sdk.objects.annotations.ApiParam;
import com.vk.api.sdk.objects.newsfeed.responses.GetListsResponse;
import java.util.Arrays;
import java.util.List;

/**
 * Query for Newsfeed.getLists method
 */
public class NewsfeedGetListsQuery 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
     */
    public NewsfeedGetListsQuery(VkApiClient client, UserActor actor) {
        super(client, "newsfeed.getLists", GetListsResponse.class);
        accessToken(actor.getAccessToken());
    }

    /**
     * Return additional list info
     *
     * @param value value of "extended" parameter. By default 0.
     * @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
     */
    @ApiParam("extended")
    public NewsfeedGetListsQuery extended(Boolean value) {
        return unsafeParam("extended", value);
    }

    /**
     * listIds
     * Numeric list identifiers.
     *
     * @param value value of "list ids" parameter.
     * @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
     */
    @ApiParam("list_ids")
    public NewsfeedGetListsQuery listIds(Integer... value) {
        return unsafeParam("list_ids", value);
    }

    /**
     * Numeric list identifiers.
     *
     * @param value value of "list ids" parameter.
     * @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
     */
    @ApiParam("list_ids")
    public NewsfeedGetListsQuery listIds(List value) {
        return unsafeParam("list_ids", value);
    }

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

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