com.vk.api.sdk.queries.friends.FriendsDeleteQuery 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.friends;

import com.vk.api.sdk.client.AbstractQueryBuilder;
import com.vk.api.sdk.client.VkApiClient;
import com.vk.api.sdk.client.actors.UserActor;
import com.vk.api.sdk.objects.annotations.ApiParam;
import com.vk.api.sdk.objects.friends.responses.DeleteResponse;
import java.util.Arrays;
import java.util.List;

/**
 * Query for Friends.delete method
 */
public class FriendsDeleteQuery extends AbstractQueryBuilder {
    /**
     * 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 FriendsDeleteQuery(VkApiClient client, UserActor actor) {
        super(client, "friends.delete", DeleteResponse.class);
        accessToken(actor.getAccessToken());
    }

    /**
     * ID of the user whose friend request is to be declined or who is to be deleted from the current user's friend list.
     *
     * @param value value of "user id" parameter. Minimum is 0. Entity - owner
     *
     * @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
     */
    @ApiParam("user_id")
    public FriendsDeleteQuery userId(Long value) {
        return unsafeParam("user_id", value);
    }

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

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