com.authy.api

Class Users

java.lang.Object

com.authy.api.Resource

com.authy.api.Users

public class Users
extends Resource

Author:

Julian Camargo

Nested Class Summary

Nested classes/interfaces inherited from class com.authy.api.Resource

Resource.Response

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_COUNTRY_CODE
static String	DELETE_USER_PATH
static String	NEW_USER_PATH
static String	ONE_CODE_CALL_PATH
static String	SMS_PATH
static String	USER_STATUS_PATH

Fields inherited from class com.authy.api.Resource

ENCODE, JSON_CONTENT_TYPE, METHOD_GET, METHOD_POST, METHOD_PUT, XML_CONTENT_TYPE

Constructor Summary

Constructors

Constructor and Description
Users(String uri, String key)
Users(String uri, String key, boolean testFlag)

Method Summary

Modifier and Type	Method and Description
User	createUser(String email, String phone) Create a new user using his e-mail and phone.
User	createUser(String email, String phone, String countryCode) Create a new user using his e-mail, phone and country code.
Hash	deleteUser(int userId) Delete a user.
Hash	requestCall(int userId) Send token via call to a user.
Hash	requestCall(int userId, Map<String,String> options) Send token via call to a user with some options defined.
Hash	requestSms(int userId) Send token via sms to a user.
Hash	requestSms(int userId, Map<String,String> options) Send token via sms to a user with some options defined.
UserStatus	requestStatus(int userId) Get user status.

Methods inherited from class com.authy.api.Resource

delete, get, getContentType, post, put

Methods inherited from class java.lang.Object

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

Field Detail

NEW_USER_PATH

public static final String NEW_USER_PATH

See Also:

Constant Field Values

DELETE_USER_PATH

public static final String DELETE_USER_PATH

See Also:

Constant Field Values

SMS_PATH

public static final String SMS_PATH

See Also:

Constant Field Values

ONE_CODE_CALL_PATH

public static final String ONE_CODE_CALL_PATH

See Also:

Constant Field Values

USER_STATUS_PATH

public static final String USER_STATUS_PATH

See Also:

Constant Field Values

DEFAULT_COUNTRY_CODE

public static final String DEFAULT_COUNTRY_CODE

See Also:

Constant Field Values

Constructor Detail

Users

public Users(String uri,
             String key)

Users

public Users(String uri,
             String key,
             boolean testFlag)

Method Detail

createUser

public User createUser(String email,
                       String phone,
                       String countryCode)
                throws AuthyException

Create a new user using his e-mail, phone and country code.

Parameters:

email -

phone -

countryCode -

Returns:

a User instance

Throws:

AuthyException

createUser

public User createUser(String email,
                       String phone)
                throws AuthyException

Create a new user using his e-mail and phone. It uses USA country code by default.

Parameters:

email -

phone -

Returns:

a User instance

Throws:

AuthyException

requestSms

public Hash requestSms(int userId)
                throws AuthyException

Send token via sms to a user.

Parameters:

userId -

Returns:

Hash instance with API's response.

Throws:

AuthyException

requestSms

public Hash requestSms(int userId,
                       Map<String,String> options)
                throws AuthyException

Send token via sms to a user with some options defined.

Parameters:

userId -

options -

Returns:

Hash instance with API's response.

Throws:

AuthyException

requestCall

public Hash requestCall(int userId)
                 throws AuthyException

Send token via call to a user.

Parameters:

userId -

Returns:

Hash instance with API's response.

Throws:

AuthyException

requestCall

public Hash requestCall(int userId,
                        Map<String,String> options)
                 throws AuthyException

Send token via call to a user with some options defined.

Parameters:

userId -

options -

Returns:

Hash instance with API's response.

Throws:

AuthyException

deleteUser

public Hash deleteUser(int userId)
                throws AuthyException

Delete a user.

Parameters:

userId -

Returns:

Hash instance with API's response.

Throws:

AuthyException

requestStatus

public UserStatus requestStatus(int userId)
                         throws AuthyException

Get user status.

Returns:

object containing user status

Throws:

AuthyException