com.vk.api.sdk.queries.newsfeed.NewsfeedGetSuggestedSourcesQuery 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.base.UserGroupFields;
import com.vk.api.sdk.objects.newsfeed.responses.GetSuggestedSourcesResponse;
import java.util.Arrays;
import java.util.List;

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

    /**
     * Offset required to choose a particular subset of communities or users.
     *
     * @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 NewsfeedGetSuggestedSourcesQuery offset(Integer value) {
        return unsafeParam("offset", value);
    }

    /**
     * Amount of communities or users to return.
     *
     * @param value value of "count" parameter. Maximum is 1000. Minimum is 0. By default 20.
     * @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
     */
    @ApiParam("count")
    public NewsfeedGetSuggestedSourcesQuery count(Integer value) {
        return unsafeParam("count", value);
    }

    /**
     * Shuffle the returned list or not.
     *
     * @param value value of "shuffle" parameter.
     * @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
     */
    @ApiParam("shuffle")
    public NewsfeedGetSuggestedSourcesQuery shuffle(Boolean value) {
        return unsafeParam("shuffle", value);
    }

    /**
     * fields
     * List of extra fields to be returned. See available fields for [vk.com/dev/fields|users] and [vk.com/dev/fields_groups|communities].
     *
     * @param value value of "fields" parameter.
     * @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
     */
    @ApiParam("fields")
    public NewsfeedGetSuggestedSourcesQuery fields(UserGroupFields... value) {
        return unsafeParam("fields", value);
    }

    /**
     * List of extra fields to be returned. See available fields for [vk.com/dev/fields|users] and [vk.com/dev/fields_groups|communities].
     *
     * @param value value of "fields" parameter.
     * @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
     */
    @ApiParam("fields")
    public NewsfeedGetSuggestedSourcesQuery fields(List value) {
        return unsafeParam("fields", value);
    }

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

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