com.vk.api.sdk.actions.AppWidgets 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.actions;

import com.vk.api.sdk.client.AbstractAction;
import com.vk.api.sdk.client.VkApiClient;
import com.vk.api.sdk.client.actors.GroupActor;
import com.vk.api.sdk.client.actors.ServiceActor;
import com.vk.api.sdk.client.actors.UserActor;
import com.vk.api.sdk.objects.annotations.ApiMethod;
import com.vk.api.sdk.objects.appwidgets.GetAppImageUploadServerImageType;
import com.vk.api.sdk.objects.appwidgets.GetGroupImageUploadServerImageType;
import com.vk.api.sdk.objects.appwidgets.UpdateType;
import com.vk.api.sdk.queries.appwidgets.AppWidgetsGetAppImageUploadServerQuery;
import com.vk.api.sdk.queries.appwidgets.AppWidgetsGetAppImagesQuery;
import com.vk.api.sdk.queries.appwidgets.AppWidgetsGetGroupImageUploadServerQuery;
import com.vk.api.sdk.queries.appwidgets.AppWidgetsGetGroupImagesQuery;
import com.vk.api.sdk.queries.appwidgets.AppWidgetsGetImagesByIdQuery;
import com.vk.api.sdk.queries.appwidgets.AppWidgetsSaveAppImageQuery;
import com.vk.api.sdk.queries.appwidgets.AppWidgetsSaveGroupImageQuery;
import com.vk.api.sdk.queries.appwidgets.AppWidgetsUpdateQuery;
import java.util.List;

/**
 * List of AppWidgets methods
 */
public class AppWidgets extends AbstractAction {
    /**
     * Constructor
     *
     * @param client vk api client
     */
    public AppWidgets(VkApiClient client) {
        super(client);
    }

    /**
     * Returns a URL for uploading a photo to the community collection for community app widgets
     *
     * @param actor vk service actor
     * @param imageType
     * @return query
     */
    @ApiMethod("appWidgets.getAppImageUploadServer")
    public AppWidgetsGetAppImageUploadServerQuery getAppImageUploadServer(ServiceActor actor,
            GetAppImageUploadServerImageType imageType) {
        return new AppWidgetsGetAppImageUploadServerQuery(getClient(), actor, imageType);
    }

    /**
     * Returns a URL for uploading a photo to the community collection for community app widgets
     *
     * @param actor vk service actor
     * @return only actor query 
     */
    @ApiMethod("appWidgets.getAppImageUploadServer")
    public AppWidgetsGetAppImageUploadServerQuery getAppImageUploadServer(ServiceActor actor) {
        return new AppWidgetsGetAppImageUploadServerQuery(getClient(), actor);
    }

    /**
     * Returns an app collection of images for community app widgets
     *
     * @param actor vk user actor
     * @return query
     */
    @ApiMethod("appWidgets.getAppImages")
    public AppWidgetsGetAppImagesQuery getAppImages(UserActor actor) {
        return new AppWidgetsGetAppImagesQuery(getClient(), actor);
    }

    /**
     * Returns an app collection of images for community app widgets
     *
     * @param actor vk group actor
     * @return query
     */
    @ApiMethod("appWidgets.getAppImages")
    public AppWidgetsGetAppImagesQuery getAppImages(GroupActor actor) {
        return new AppWidgetsGetAppImagesQuery(getClient(), actor);
    }

    /**
     * Returns an app collection of images for community app widgets
     *
     * @param actor vk service actor
     * @return query
     */
    @ApiMethod("appWidgets.getAppImages")
    public AppWidgetsGetAppImagesQuery getAppImages(ServiceActor actor) {
        return new AppWidgetsGetAppImagesQuery(getClient(), actor);
    }

    /**
     * Returns a URL for uploading a photo to the community collection for community app widgets
     *
     * @param actor vk group actor
     * @param imageType
     * @return query
     */
    @ApiMethod("appWidgets.getGroupImageUploadServer")
    public AppWidgetsGetGroupImageUploadServerQuery getGroupImageUploadServer(GroupActor actor,
            GetGroupImageUploadServerImageType imageType) {
        return new AppWidgetsGetGroupImageUploadServerQuery(getClient(), actor, imageType);
    }

    /**
     * Returns a URL for uploading a photo to the community collection for community app widgets
     *
     * @param actor vk group actor
     * @return only actor query 
     */
    @ApiMethod("appWidgets.getGroupImageUploadServer")
    public AppWidgetsGetGroupImageUploadServerQuery getGroupImageUploadServer(GroupActor actor) {
        return new AppWidgetsGetGroupImageUploadServerQuery(getClient(), actor);
    }

    /**
     * Returns a community collection of images for community app widgets
     *
     * @param actor vk group actor
     * @return query
     */
    @ApiMethod("appWidgets.getGroupImages")
    public AppWidgetsGetGroupImagesQuery getGroupImages(GroupActor actor) {
        return new AppWidgetsGetGroupImagesQuery(getClient(), actor);
    }

    /**
     * Returns an image for community app widgets by its ID
     *
     * @param actor vk user actor
     * @param images List of images IDs
     * @return query
     */
    @ApiMethod("appWidgets.getImagesById")
    public AppWidgetsGetImagesByIdQuery getImagesById(UserActor actor, String... images) {
        return new AppWidgetsGetImagesByIdQuery(getClient(), actor, images);
    }

    /**
     * Returns an image for community app widgets by its ID
     *
     * @param actor vk user actor
     * @param images List of images IDs
     * @return query
     */
    @ApiMethod("appWidgets.getImagesById")
    public AppWidgetsGetImagesByIdQuery getImagesById(UserActor actor, List images) {
        return new AppWidgetsGetImagesByIdQuery(getClient(), actor, images);
    }

    /**
     * Returns an image for community app widgets by its ID
     *
     * @param actor vk user actor
     * @return only actor query 
     */
    @ApiMethod("appWidgets.getImagesById")
    public AppWidgetsGetImagesByIdQuery getImagesById(UserActor actor) {
        return new AppWidgetsGetImagesByIdQuery(getClient(), actor);
    }

    /**
     * Returns an image for community app widgets by its ID
     *
     * @param actor vk group actor
     * @param images List of images IDs
     * @return query
     */
    @ApiMethod("appWidgets.getImagesById")
    public AppWidgetsGetImagesByIdQuery getImagesById(GroupActor actor, String... images) {
        return new AppWidgetsGetImagesByIdQuery(getClient(), actor, images);
    }

    /**
     * Returns an image for community app widgets by its ID
     *
     * @param actor vk group actor
     * @param images List of images IDs
     * @return query
     */
    @ApiMethod("appWidgets.getImagesById")
    public AppWidgetsGetImagesByIdQuery getImagesById(GroupActor actor, List images) {
        return new AppWidgetsGetImagesByIdQuery(getClient(), actor, images);
    }

    /**
     * Returns an image for community app widgets by its ID
     *
     * @param actor vk group actor
     * @return only actor query 
     */
    @ApiMethod("appWidgets.getImagesById")
    public AppWidgetsGetImagesByIdQuery getImagesById(GroupActor actor) {
        return new AppWidgetsGetImagesByIdQuery(getClient(), actor);
    }

    /**
     * Returns an image for community app widgets by its ID
     *
     * @param actor vk service actor
     * @param images List of images IDs
     * @return query
     */
    @ApiMethod("appWidgets.getImagesById")
    public AppWidgetsGetImagesByIdQuery getImagesById(ServiceActor actor, String... images) {
        return new AppWidgetsGetImagesByIdQuery(getClient(), actor, images);
    }

    /**
     * Returns an image for community app widgets by its ID
     *
     * @param actor vk service actor
     * @param images List of images IDs
     * @return query
     */
    @ApiMethod("appWidgets.getImagesById")
    public AppWidgetsGetImagesByIdQuery getImagesById(ServiceActor actor, List images) {
        return new AppWidgetsGetImagesByIdQuery(getClient(), actor, images);
    }

    /**
     * Returns an image for community app widgets by its ID
     *
     * @param actor vk service actor
     * @return only actor query 
     */
    @ApiMethod("appWidgets.getImagesById")
    public AppWidgetsGetImagesByIdQuery getImagesById(ServiceActor actor) {
        return new AppWidgetsGetImagesByIdQuery(getClient(), actor);
    }

    /**
     * Allows to save image into app collection for community app widgets
     *
     * @param actor vk service actor
     * @param hash Parameter returned when photo is uploaded to server
     * @param image Parameter returned when photo is uploaded to server
     * @return query
     */
    @ApiMethod("appWidgets.saveAppImage")
    public AppWidgetsSaveAppImageQuery saveAppImage(ServiceActor actor, String hash, String image) {
        return new AppWidgetsSaveAppImageQuery(getClient(), actor, hash, image);
    }

    /**
     * Allows to save image into app collection for community app widgets
     *
     * @param actor vk service actor
     * @return only actor query 
     */
    @ApiMethod("appWidgets.saveAppImage")
    public AppWidgetsSaveAppImageQuery saveAppImage(ServiceActor actor) {
        return new AppWidgetsSaveAppImageQuery(getClient(), actor);
    }

    /**
     * Allows to save image into community collection for community app widgets
     *
     * @param actor vk group actor
     * @param hash Parameter returned when photo is uploaded to server
     * @param image Parameter returned when photo is uploaded to server
     * @return query
     */
    @ApiMethod("appWidgets.saveGroupImage")
    public AppWidgetsSaveGroupImageQuery saveGroupImage(GroupActor actor, String hash,
            String image) {
        return new AppWidgetsSaveGroupImageQuery(getClient(), actor, hash, image);
    }

    /**
     * Allows to save image into community collection for community app widgets
     *
     * @param actor vk group actor
     * @return only actor query 
     */
    @ApiMethod("appWidgets.saveGroupImage")
    public AppWidgetsSaveGroupImageQuery saveGroupImage(GroupActor actor) {
        return new AppWidgetsSaveGroupImageQuery(getClient(), actor);
    }

    /**
     * Allows to update community app widget
     *
     * @param actor vk group actor
     * @param code
     * @param type
     * @return query
     */
    @ApiMethod("appWidgets.update")
    public AppWidgetsUpdateQuery update(GroupActor actor, String code, UpdateType type) {
        return new AppWidgetsUpdateQuery(getClient(), actor, code, type);
    }

    /**
     * Allows to update community app widget
     *
     * @param actor vk group actor
     * @return only actor query 
     */
    @ApiMethod("appWidgets.update")
    public AppWidgetsUpdateQuery update(GroupActor actor) {
        return new AppWidgetsUpdateQuery(getClient(), actor);
    }
}