com.vk.api.sdk.queries.friends.FriendsGetMutualQueryWithTargetUids 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.GetMutualTargetUidsResponse;
import java.util.Arrays;
import java.util.List;

/**
 * Query for Friends.getMutual method
 */
public class FriendsGetMutualQueryWithTargetUids 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 FriendsGetMutualQueryWithTargetUids(VkApiClient client, UserActor actor,
            Long... targetUids) {
        super(client, "friends.getMutual", Utils.buildParametrizedType(List.class, GetMutualTargetUidsResponse.class));
        accessToken(actor.getAccessToken());
        targetUids(targetUids);
    }

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

    /**
     * ID of the user whose friends will be checked against the friends of the user specified in 'target_uid'.
     *
     * @param value value of "source uid" parameter. Minimum is 1. Entity - owner
     *
     * @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
     */
    @ApiParam("source_uid")
    public FriendsGetMutualQueryWithTargetUids sourceUid(Long value) {
        return unsafeParam("source_uid", value);
    }

    /**
     * ID of the user whose friends will be checked against the friends of the user specified in 'source_uid'.
     *
     * @param value value of "target uid" parameter. Minimum is 1. Entity - owner
     *
     * @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
     */
    @ApiParam("target_uid")
    public FriendsGetMutualQueryWithTargetUids targetUid(Long value) {
        return unsafeParam("target_uid", value);
    }

    /**
     * Sort order: 'random' - random order
     *
     * @param value value of "order" parameter.
     * @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
     */
    @ApiParam("order")
    public FriendsGetMutualQueryWithTargetUids order(String value) {
        return unsafeParam("order", value);
    }

    /**
     * Number of mutual friends to return.
     *
     * @param value value of "count" parameter. Minimum is 0.
     * @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
     */
    @ApiParam("count")
    public FriendsGetMutualQueryWithTargetUids count(Integer value) {
        return unsafeParam("count", value);
    }

    /**
     * Offset needed to return a specific subset of mutual friends.
     *
     * @param value value of "offset" parameter. Minimum is 0.
     * @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
     */
    @ApiParam("offset")
    public FriendsGetMutualQueryWithTargetUids offset(Integer value) {
        return unsafeParam("offset", value);
    }

    /**
     * targetUids
     * IDs of the users whose friends will be checked against the friends of the user specified in 'source_uid'.
     *
     * @param value value of "target uids" parameter.
     * @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
     */
    @ApiParam("target_uids")
    protected FriendsGetMutualQueryWithTargetUids targetUids(Long... value) {
        return unsafeParam("target_uids", value);
    }

    /**
     * IDs of the users whose friends will be checked against the friends of the user specified in 'source_uid'.
     *
     * @param value value of "target uids" parameter.
     * @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
     */
    @ApiParam("target_uids")
    protected FriendsGetMutualQueryWithTargetUids targetUids(List value) {
        return unsafeParam("target_uids", value);
    }

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

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