Package com.vk.api.sdk.queries.auth

Class AuthCheckPhoneQuery

java.lang.Object

com.vk.api.sdk.client.ApiRequest<R>

com.vk.api.sdk.client.AbstractQueryBuilder<AuthCheckPhoneQuery,OkResponse>

com.vk.api.sdk.queries.auth.AuthCheckPhoneQuery

public class AuthCheckPhoneQuery
extends AbstractQueryBuilder<AuthCheckPhoneQuery,OkResponse>

Query for Auth.checkPhone method

Constructor Summary

Constructors

Constructor	Description
AuthCheckPhoneQuery(VkApiClient client, UserActor actor, java.lang.String phone)	Creates a AbstractQueryBuilder instance that can be used to build api request with various parameters
AuthCheckPhoneQuery(VkApiClient client, java.lang.String phone)	Creates a AbstractQueryBuilder instance that can be used to build api request with various parameters

Method Summary

Modifier and Type	Method	Description
AuthCheckPhoneQuery	authByPhone(java.lang.Boolean value)	Set auth by phone
AuthCheckPhoneQuery	clientId(java.lang.Integer value)	User ID.
AuthCheckPhoneQuery	clientSecret(java.lang.String value)	Set client secret
protected java.util.List<java.lang.String>	essentialKeys()	Get list of required parameter names
protected AuthCheckPhoneQuery	getThis()	Get reference to this object
protected AuthCheckPhoneQuery	phone(java.lang.String value)	Phone number.

Methods inherited from class com.vk.api.sdk.client.AbstractQueryBuilder

accessToken, build, captchaKey, captchaSid, confirm, getBody, getMethod, getParams, lang, toString, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, version

Methods inherited from class com.vk.api.sdk.client.ApiRequest

execute, executeAsRaw, executeAsString, getClient, getGson, getHeaders, getResponseClass, getUrl, setHeaders

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AuthCheckPhoneQuery

public AuthCheckPhoneQuery(VkApiClient client,
                           UserActor actor,
                           java.lang.String phone)

Creates a AbstractQueryBuilder instance that can be used to build api request with various parameters

Parameters:

client - VK API client

actor - actor with access token

phone - value of "phone" parameter.

AuthCheckPhoneQuery

public AuthCheckPhoneQuery(VkApiClient client,
                           java.lang.String phone)

Creates a AbstractQueryBuilder instance that can be used to build api request with various parameters

Parameters:

client - VK API client

phone - value of "phone" parameter.

Method Detail

phone

protected AuthCheckPhoneQuery phone(java.lang.String value)

Phone number.

Parameters:

value - value of "phone" parameter.

Returns:

a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

clientId

public AuthCheckPhoneQuery clientId(java.lang.Integer value)

User ID.

Parameters:

value - value of "client id" parameter.

Returns:

a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

clientSecret

public AuthCheckPhoneQuery clientSecret(java.lang.String value)

Set client secret

Overrides:

clientSecret in class AbstractQueryBuilder<AuthCheckPhoneQuery,OkResponse>

Parameters:

value - value of "client secret" parameter.

Returns:

a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

authByPhone

public AuthCheckPhoneQuery authByPhone(java.lang.Boolean value)

Set auth by phone

Parameters:

value - value of "auth by phone" parameter.

Returns:

a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

getThis

protected AuthCheckPhoneQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<AuthCheckPhoneQuery,OkResponse>

Returns:

a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

essentialKeys

protected java.util.List<java.lang.String> essentialKeys()

Description copied from class: AbstractQueryBuilder

Get list of required parameter names

Specified by:

essentialKeys in class AbstractQueryBuilder<AuthCheckPhoneQuery,OkResponse>

Returns:

list of names