com.vk.api.sdk.queries.donut.DonutGetFriendsQueryWithFields 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.donut;

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.groups.responses.GetMembersFieldsResponse;
import java.util.Arrays;
import java.util.List;

/**
 * Query for Donut.getFriends method
 */
public class DonutGetFriendsQueryWithFields 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 ownerId value of "owner id" parameter. Entity - owner
     *
     */
    public DonutGetFriendsQueryWithFields(VkApiClient client, UserActor actor, Long ownerId,
            String... fields) {
        super(client, "donut.getFriends", GetMembersFieldsResponse.class);
        accessToken(actor.getAccessToken());
        ownerId(ownerId);
        fields(fields);
    }

    /**
     * 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 ownerId value of "owner id" parameter. Entity - owner
     *
     */
    public DonutGetFriendsQueryWithFields(VkApiClient client, UserActor actor, Long ownerId,
            List fields) {
        super(client, "donut.getFriends", GetMembersFieldsResponse.class);
        accessToken(actor.getAccessToken());
        ownerId(ownerId);
        fields(fields);
    }

    /**
     * Set owner id
     *
     * @param value value of "owner id" parameter. Entity - owner
     *
     * @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
     */
    @ApiParam("owner_id")
    public DonutGetFriendsQueryWithFields ownerId(Long value) {
        return unsafeParam("owner_id", value);
    }

    /**
     * Set offset
     *
     * @param value value of "offset" parameter. Minimum is 0. By default 0.
     * @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
     */
    @ApiParam("offset")
    public DonutGetFriendsQueryWithFields offset(Integer value) {
        return unsafeParam("offset", value);
    }

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

    /**
     * fields
     * Set fields
     *
     * @param value value of "fields" parameter.
     * @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
     */
    @ApiParam("fields")
    protected DonutGetFriendsQueryWithFields fields(String... value) {
        return unsafeParam("fields", value);
    }

    /**
     * Set fields
     *
     * @param value value of "fields" parameter.
     * @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
     */
    @ApiParam("fields")
    protected DonutGetFriendsQueryWithFields fields(List value) {
        return unsafeParam("fields", value);
    }

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

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