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

import com.vk.api.sdk.client.AbstractQueryBuilder;
import com.vk.api.sdk.client.Utils;
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.AreFriendsResponse;
import java.util.Arrays;
import java.util.List;

/**
 * Query for Friends.areFriends method
 */
public class FriendsAreFriendsQuery 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
     * @param userIds value of "user ids" parameter.
     */
    public FriendsAreFriendsQuery(VkApiClient client, UserActor actor, Long... userIds) {
        super(client, "friends.areFriends", Utils.buildParametrizedType(List.class, AreFriendsResponse.class));
        accessToken(actor.getAccessToken());
        userIds(userIds);
    }

    /**
     * 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 userIds value of "user ids" parameter.
     */
    public FriendsAreFriendsQuery(VkApiClient client, UserActor actor, List userIds) {
        super(client, "friends.areFriends", Utils.buildParametrizedType(List.class, AreFriendsResponse.class));
        accessToken(actor.getAccessToken());
        userIds(userIds);
    }

    /**
     * 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 FriendsAreFriendsQuery(VkApiClient client, UserActor actor) {
        super(client, "friends.areFriends", Utils.buildParametrizedType(List.class, AreFriendsResponse.class));
        accessToken(actor.getAccessToken());
    }

    /**
     * '1' - to return 'sign' field. 'sign' is md5("{id}_{user_id}_{friends_status}_{application_secret}"), where id is current user ID. This field allows to check that data has not been modified by the client. By default: '0'.
     *
     * @param value value of "need sign" parameter.
     * @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
     */
    @ApiParam("need_sign")
    public FriendsAreFriendsQuery needSign(Boolean value) {
        return unsafeParam("need_sign", value);
    }

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

    /**
     * userIds
     * IDs of the users whose friendship status to check.
     *
     * @param value value of "user ids" parameter.
     * @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
     */
    @ApiParam("user_ids")
    public FriendsAreFriendsQuery userIds(Long... value) {
        return unsafeParam("user_ids", value);
    }

    /**
     * IDs of the users whose friendship status to check.
     *
     * @param value value of "user ids" parameter.
     * @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
     */
    @ApiParam("user_ids")
    public FriendsAreFriendsQuery userIds(List value) {
        return unsafeParam("user_ids", value);
    }

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

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