com.vk.api.sdk.queries.market.MarketGetAlbumByIdQuery Maven / Gradle / Ivy

Go to download
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.market;

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.market.responses.GetAlbumByIdResponse;

import java.util.Arrays;
import java.util.List;

/**
 * Query for Market.getAlbumById method
 */
public class MarketGetAlbumByIdQuery 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
     *
     * @param albumIds value of "album ids" parameter.
     */
    public MarketGetAlbumByIdQuery(VkApiClient client, UserActor actor, Long ownerId,
            Integer... albumIds) {
        super(client, "market.getAlbumById", GetAlbumByIdResponse.class);
        accessToken(actor.getAccessToken());
        ownerId(ownerId);
        albumIds(albumIds);
    }

    /**
     * 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
     *
     * @param albumIds value of "album ids" parameter.
     */
    public MarketGetAlbumByIdQuery(VkApiClient client, UserActor actor, Long ownerId,
            List albumIds) {
        super(client, "market.getAlbumById", GetAlbumByIdResponse.class);
        accessToken(actor.getAccessToken());
        ownerId(ownerId);
        albumIds(albumIds);
    }

    /**
     * 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 MarketGetAlbumByIdQuery(VkApiClient client, UserActor actor) {
        super(client, "market.getAlbumById", GetAlbumByIdResponse.class);
        accessToken(actor.getAccessToken());
    }

    /**
     * Identifier of an album owner community, "Note that community id in the 'owner_id' parameter should be negative number. For example 'owner_id'=-1 matches the [vk.com/apiclub|VK API] community "
     *
     * @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 MarketGetAlbumByIdQuery ownerId(Long value) {
        return unsafeParam("owner_id", value);
    }

    /**
     * albumIds
     * Collections identifiers to obtain data from
     *
     * @param value value of "album ids" parameter.
     * @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
     */
    @ApiParam("album_ids")
    public MarketGetAlbumByIdQuery albumIds(Integer... value) {
        return unsafeParam("album_ids", value);
    }

    /**
     * Collections identifiers to obtain data from
     *
     * @param value value of "album ids" parameter.
     * @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
     */
    @ApiParam("album_ids")
    public MarketGetAlbumByIdQuery albumIds(List value) {
        return unsafeParam("album_ids", value);
    }

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

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