com.vk.api.sdk.queries.messages.MessagesGetConversationsByIdQuery Maven / Gradle / Ivy

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

import com.vk.api.sdk.client.AbstractQueryBuilder;
import com.vk.api.sdk.client.VkApiClient;
import com.vk.api.sdk.client.actors.GroupActor;
import com.vk.api.sdk.client.actors.UserActor;
import com.vk.api.sdk.objects.base.UserGroupFields;
import com.vk.api.sdk.objects.messages.responses.GetConversationsByIdResponse;
import java.util.Arrays;
import java.util.List;

/**
 * Query for Messages.getConversationsById method
 */
public class MessagesGetConversationsByIdQuery 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 peerIds value of "peer ids" parameter.
     */
    public MessagesGetConversationsByIdQuery(VkApiClient client, UserActor actor,
            Integer... peerIds) {
        super(client, "messages.getConversationsById", GetConversationsByIdResponse.class);
        accessToken(actor.getAccessToken());
        peerIds(peerIds);
    }

    /**
     * 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 peerIds value of "peer ids" parameter.
     */
    public MessagesGetConversationsByIdQuery(VkApiClient client, UserActor actor,
            List peerIds) {
        super(client, "messages.getConversationsById", GetConversationsByIdResponse.class);
        accessToken(actor.getAccessToken());
        peerIds(peerIds);
    }

    /**
     * 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 peerIds value of "peer ids" parameter.
     */
    public MessagesGetConversationsByIdQuery(VkApiClient client, GroupActor actor,
            Integer... peerIds) {
        super(client, "messages.getConversationsById", GetConversationsByIdResponse.class);
        accessToken(actor.getAccessToken());
        groupId(actor.getGroupId());
        peerIds(peerIds);
    }

    /**
     * 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 peerIds value of "peer ids" parameter.
     */
    public MessagesGetConversationsByIdQuery(VkApiClient client, GroupActor actor,
            List peerIds) {
        super(client, "messages.getConversationsById", GetConversationsByIdResponse.class);
        accessToken(actor.getAccessToken());
        groupId(actor.getGroupId());
        peerIds(peerIds);
    }

    /**
     * Return extended properties
     *
     * @param value value of "extended" parameter.
     * @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
     */
    public MessagesGetConversationsByIdQuery extended(Boolean value) {
        return unsafeParam("extended", value);
    }

    /**
     * Group ID (for group messages with group access token)
     *
     * @param value value of "group id" parameter. Minimum is 0.
     * @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
     */
    public MessagesGetConversationsByIdQuery groupId(Integer value) {
        return unsafeParam("group_id", value);
    }

    /**
     * peer_ids
     * Destination IDs. "For user: 'User ID', e.g. '12345'. For chat: '2000000000' + 'chat_id', e.g. '2000000001'. For community: '- community ID', e.g. '-12345'. "
     *
     * @param value value of "peer ids" parameter.
     * @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
     */
    protected MessagesGetConversationsByIdQuery peerIds(Integer... value) {
        return unsafeParam("peer_ids", value);
    }

    /**
     * Destination IDs. "For user: 'User ID', e.g. '12345'. For chat: '2000000000' + 'chat_id', e.g. '2000000001'. For community: '- community ID', e.g. '-12345'. "
     *
     * @param value value of "peer ids" parameter.
     * @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
     */
    protected MessagesGetConversationsByIdQuery peerIds(List value) {
        return unsafeParam("peer_ids", value);
    }

    /**
     * fields
     * Profile and communities fields to return.
     *
     * @param value value of "fields" parameter.
     * @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
     */
    public MessagesGetConversationsByIdQuery fields(UserGroupFields... value) {
        return unsafeParam("fields", value);
    }

    /**
     * Profile and communities fields to return.
     *
     * @param value value of "fields" parameter.
     * @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
     */
    public MessagesGetConversationsByIdQuery fields(List value) {
        return unsafeParam("fields", value);
    }

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

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