com.vk.api.sdk.actions.Polls Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of core Show documentation
Java library for VK API interaction, includes OAuth 2.0 authorization and API methods.
The newest version!
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.UserActor;
import com.vk.api.sdk.queries.polls.PollsAddVoteQuery;
import com.vk.api.sdk.queries.polls.PollsCreateQuery;
import com.vk.api.sdk.queries.polls.PollsDeleteVoteQuery;
import com.vk.api.sdk.queries.polls.PollsEditQuery;
import com.vk.api.sdk.queries.polls.PollsGetByIdQuery;
import com.vk.api.sdk.queries.polls.PollsGetVotersQuery;
import java.util.List;

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

    /**
     * Returns detailed information about a poll by its ID.
     *
     * @param actor vk actor
     * @param pollId Poll ID.
     * @return query
     */
    public PollsGetByIdQuery getById(UserActor actor, int pollId) {
        return new PollsGetByIdQuery(getClient(), actor, pollId);
    }

    /**
     * Adds the current user's vote to the selected answer in the poll.
     *
     * @param actor vk actor
     * @param pollId Poll ID.
     * @param answerIds
     * @return query
     */
    public PollsAddVoteQuery addVote(UserActor actor, int pollId, Integer... answerIds) {
        return new PollsAddVoteQuery(getClient(), actor, pollId, answerIds);
    }

    /**
     * Adds the current user's vote to the selected answer in the poll.
     *
     * @param actor vk actor
     * @param pollId Poll ID.
     * @param answerIds
     * @return query
     */
    public PollsAddVoteQuery addVote(UserActor actor, int pollId, List answerIds) {
        return new PollsAddVoteQuery(getClient(), actor, pollId, answerIds);
    }

    /**
     * Deletes the current user's vote from the selected answer in the poll.
     *
     * @param actor vk actor
     * @param pollId Poll ID.
     * @param answerId Answer ID.
     * @return query
     */
    public PollsDeleteVoteQuery deleteVote(UserActor actor, int pollId, int answerId) {
        return new PollsDeleteVoteQuery(getClient(), actor, pollId, answerId);
    }

    /**
     * Returns a list of IDs of users who selected specific answers in the poll.
     *
     * @param actor vk actor
     * @param pollId Poll ID.
     * @param answerIds Answer IDs.
     * @return query
     */
    public PollsGetVotersQuery getVoters(UserActor actor, int pollId, Integer... answerIds) {
        return new PollsGetVotersQuery(getClient(), actor, pollId, answerIds);
    }

    /**
     * Returns a list of IDs of users who selected specific answers in the poll.
     *
     * @param actor vk actor
     * @param pollId Poll ID.
     * @param answerIds Answer IDs.
     * @return query
     */
    public PollsGetVotersQuery getVoters(UserActor actor, int pollId, List answerIds) {
        return new PollsGetVotersQuery(getClient(), actor, pollId, answerIds);
    }

    /**
     * Creates polls that can be attached to the users' or communities' posts.
     *
     * @param actor vk actor
     * @return query
     */
    public PollsCreateQuery create(UserActor actor) {
        return new PollsCreateQuery(getClient(), actor);
    }

    /**
     * Edits created polls
     *
     * @param actor vk actor
     * @param pollId edited poll's id
     * @return query
     */
    public PollsEditQuery edit(UserActor actor, int pollId) {
        return new PollsEditQuery(getClient(), actor, pollId);
    }
}