com.vk.api.sdk.queries.messages.MessagesGetInviteLinkQuery 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.
There is a newer version: 1.0.16
// Autogenerated from vk-api-schema. Please don't edit it manually.
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.annotations.ApiParam;
import com.vk.api.sdk.objects.messages.responses.GetInviteLinkResponse;
import java.util.Arrays;
import java.util.List;

/**
 * Query for Messages.getInviteLink method
 */
public class MessagesGetInviteLinkQuery extends AbstractQueryBuilder {
    /**
     * Creates a AbstractQueryBuilder instance that can be used to build group api request with various parameters
     *
     * @param client VK API client
     * @param actor actor with access token
     * @param peerId value of "peer id" parameter.
     */
    public MessagesGetInviteLinkQuery(VkApiClient client, GroupActor actor, Long peerId) {
        super(client, "messages.getInviteLink", GetInviteLinkResponse.class);
        accessToken(actor.getAccessToken());
        groupId(actor.getGroupId());
        peerId(peerId);
    }

    /**
     * Creates a AbstractQueryBuilder instance that can be used to build group api request with various parameters
     *
     * @param client VK API client
     * @param actor actor with access token
     */
    public MessagesGetInviteLinkQuery(VkApiClient client, GroupActor actor) {
        super(client, "messages.getInviteLink", GetInviteLinkResponse.class);
        accessToken(actor.getAccessToken());
        groupId(actor.getGroupId());
    }

    /**
     * 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 peerId value of "peer id" parameter.
     */
    public MessagesGetInviteLinkQuery(VkApiClient client, UserActor actor, Long peerId) {
        super(client, "messages.getInviteLink", GetInviteLinkResponse.class);
        accessToken(actor.getAccessToken());
        peerId(peerId);
    }

    /**
     * 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 MessagesGetInviteLinkQuery(VkApiClient client, UserActor actor) {
        super(client, "messages.getInviteLink", GetInviteLinkResponse.class);
        accessToken(actor.getAccessToken());
    }

    /**
     * Destination ID.
     *
     * @param value value of "peer id" parameter.
     * @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
     */
    @ApiParam("peer_id")
    public MessagesGetInviteLinkQuery peerId(Long value) {
        return unsafeParam("peer_id", value);
    }

    /**
     * 1 - to generate new link (revoke previous), 0 - to return previous link.
     *
     * @param value value of "reset" parameter. By default false.
     * @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
     */
    @ApiParam("reset")
    public MessagesGetInviteLinkQuery reset(Boolean value) {
        return unsafeParam("reset", value);
    }

    /**
     * Group ID
     *
     * @param value value of "group id" parameter. Minimum is 0. Entity - owner
     *
     * @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
     */
    @ApiParam("group_id")
    public MessagesGetInviteLinkQuery groupId(Long value) {
        return unsafeParam("group_id", value);
    }

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

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