com.vk.api.sdk.queries.photos.PhotosGetByIdQueryWithLegacyExtended Maven / Gradle / Ivy

Go to download
package com.vk.api.sdk.queries.photos;

import com.vk.api.sdk.client.AbstractQueryBuilder;
import com.vk.api.sdk.client.Utils;
import com.vk.api.sdk.client.VkApiClient;
import com.vk.api.sdk.client.actors.ServiceActor;
import com.vk.api.sdk.client.actors.UserActor;
import com.vk.api.sdk.objects.photos.responses.GetByIdLegacyExtendedResponse;
import java.util.Arrays;
import java.util.List;

/**
 * Query for Photos.getById method
 */
public class PhotosGetByIdQueryWithLegacyExtended 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
     * @param photos value of "photos" parameter.
     */
    public PhotosGetByIdQueryWithLegacyExtended(VkApiClient client, UserActor actor,
            String... photos) {
        super(client, "photos.getById", Utils.buildParametrizedType(List.class, GetByIdLegacyExtendedResponse.class));
        accessToken(actor.getAccessToken());
        photos(photos);
        extended(true);
    }

    /**
     * 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
     * @param photos value of "photos" parameter.
     */
    public PhotosGetByIdQueryWithLegacyExtended(VkApiClient client, UserActor actor,
            List photos) {
        super(client, "photos.getById", Utils.buildParametrizedType(List.class, GetByIdLegacyExtendedResponse.class));
        accessToken(actor.getAccessToken());
        photos(photos);
        extended(true);
    }

    /**
     * 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
     * @param photos value of "photos" parameter.
     */
    public PhotosGetByIdQueryWithLegacyExtended(VkApiClient client, ServiceActor actor,
            String... photos) {
        super(client, "photos.getById", Utils.buildParametrizedType(List.class, GetByIdLegacyExtendedResponse.class));
        accessToken(actor.getAccessToken());
        clientSecret(actor.getClientSecret());
        photos(photos);
        extended(true);
    }

    /**
     * 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
     * @param photos value of "photos" parameter.
     */
    public PhotosGetByIdQueryWithLegacyExtended(VkApiClient client, ServiceActor actor,
            List photos) {
        super(client, "photos.getById", Utils.buildParametrizedType(List.class, GetByIdLegacyExtendedResponse.class));
        accessToken(actor.getAccessToken());
        clientSecret(actor.getClientSecret());
        photos(photos);
        extended(true);
    }

    /**
     * '1' — to return additional fields, '0' — (default)
     *
     * @param value value of "extended" parameter.
     * @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
     */
    public PhotosGetByIdQueryWithLegacyExtended extended(Boolean value) {
        return unsafeParam("extended", value);
    }

    /**
     * '1' — to return photo sizes in a
     *
     * @param value value of "photo sizes" parameter.
     * @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
     */
    public PhotosGetByIdQueryWithLegacyExtended photoSizes(Boolean value) {
        return unsafeParam("photo_sizes", value);
    }

    /**
     * photos
     * IDs separated with a comma, that are IDs of users who posted photos and IDs of photos themselves with an underscore character between such IDs. To get information about a photo in the group album, you shall specify group ID instead of user ID. Example: "1_129207899,6492_135055734, , -20629724_271945303"
     *
     * @param value value of "photos" parameter.
     * @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
     */
    protected PhotosGetByIdQueryWithLegacyExtended photos(String... value) {
        return unsafeParam("photos", value);
    }

    /**
     * IDs separated with a comma, that are IDs of users who posted photos and IDs of photos themselves with an underscore character between such IDs. To get information about a photo in the group album, you shall specify group ID instead of user ID. Example: "1_129207899,6492_135055734, , -20629724_271945303"
     *
     * @param value value of "photos" parameter.
     * @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
     */
    protected PhotosGetByIdQueryWithLegacyExtended photos(List value) {
        return unsafeParam("photos", value);
    }

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

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