com.authy.api

Class Instance

java.lang.Object

com.authy.api.Instance

Direct Known Subclasses:

Hash, OneTouchResponse, PhoneInfoResponse, Token, User, UserStatus, Verification

public class Instance
extends Object

Generic class to instance a response from the API

Author:

Julian Camargo

Constructor Summary

Constructors

Constructor and Description
Instance()
Instance(int status, String content)
Instance(int status, String content, String message)

Method Summary

Modifier and Type	Method and Description
Error	getError() Return an Error object with the error that have occurred or null.
int	getStatus()
boolean	isOk() Check if this is instance is correct.
void	setError(Error error) Set an Error object.
void	setStatus(int status)
String	toXML() Map a Token instance to its XML representation.

Methods inherited from class java.lang.Object

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

Constructor Detail

Instance

public Instance()

Instance

public Instance(int status,
                String content)

Instance

public Instance(int status,
                String content,
                String message)

Method Detail

isOk

public boolean isOk()

Check if this is instance is correct. (i.e No error occurred)

Returns:

true if no error occurred else false.

getError

public Error getError()

Return an Error object with the error that have occurred or null.

Returns:

an Error object

setError

public void setError(Error error)

Set an Error object.

getStatus

public int getStatus()

setStatus

public void setStatus(int status)

toXML

public String toXML()

Map a Token instance to its XML representation.

Returns:

a String with the description of this object in XML.