com.vk.api.sdk.queries.auth.AuthCheckPhoneQuery 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

package com.vk.api.sdk.queries.auth;

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.base.responses.OkResponse;
import java.util.Arrays;
import java.util.List;

/**
 * Query for Auth.checkPhone method
 */
public class AuthCheckPhoneQuery 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 phone value of "phone" parameter.
     */
    public AuthCheckPhoneQuery(VkApiClient client, UserActor actor, String phone) {
        super(client, "auth.checkPhone", OkResponse.class);
        accessToken(actor.getAccessToken());
        phone(phone);
    }

    /**
     * Creates a AbstractQueryBuilder instance that can be used to build api request with various parameters
     *
     * @param client VK API client
     * @param phone value of "phone" parameter.
     */
    public AuthCheckPhoneQuery(VkApiClient client, String phone) {
        super(client, "auth.checkPhone", OkResponse.class);
        phone(phone);
    }

    /**
     * Phone number.
     *
     * @param value value of "phone" parameter.
     * @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
     */
    protected AuthCheckPhoneQuery phone(String value) {
        return unsafeParam("phone", value);
    }

    /**
     * User ID.
     *
     * @param value value of "client id" parameter.
     * @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
     */
    public AuthCheckPhoneQuery clientId(Integer value) {
        return unsafeParam("client_id", value);
    }

    /**
     * Set client secret
     *
     * @param value value of "client secret" parameter.
     * @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
     */
    public AuthCheckPhoneQuery clientSecret(String value) {
        return unsafeParam("client_secret", value);
    }

    /**
     * Set auth by phone
     *
     * @param value value of "auth by phone" parameter.
     * @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
     */
    public AuthCheckPhoneQuery authByPhone(Boolean value) {
        return unsafeParam("auth_by_phone", value);
    }

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

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