Package com.mailosaur

Class Devices

java.lang.Object

com.mailosaur.Devices

public class Devices
extends Object

Constructor Summary

Constructors

Constructor	Description
Devices(MailosaurClient client)

Method Summary

Modifier and Type	Method	Description
Device	create(DeviceCreateOptions options)	Creates a new virtual security device.
void	delete(String deviceId)	Permanently delete a device.
DeviceListResult	list()	Returns a list of your virtual security devices.
OtpResult	otp(String query)	Retrieve the current one-time password.

Methods inherited from class java.lang.Object

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

Constructor Details

Devices

public Devices(MailosaurClient client)

Method Details

list

public DeviceListResult list()
                      throws IOException,
MailosaurException

Returns a list of your virtual security devices.

Returns:

The result of the device listing operation.

Throws:

MailosaurException - Thrown if Mailosaur responds with an error.

IOException - Unexpected exception.

create

public Device create(DeviceCreateOptions options)
              throws IOException,
MailosaurException

Creates a new virtual security device.

Parameters:

options - Options used to create a new Mailosaur virtual security device.

Returns:

Mailosaur virtual security device.

Throws:

MailosaurException - Thrown if Mailosaur responds with an error.

IOException - Unexpected exception.

otp

public OtpResult otp(String query)
              throws IOException,
MailosaurException

Retrieve the current one-time password.

Parameters:

query - Either the unique identifier of the device, or a base32-encoded shared secret.

Returns:

The current one-time password.

Throws:

MailosaurException - Thrown if Mailosaur responds with an error.

IOException - Unexpected exception.

delete

public void delete(String deviceId)
            throws MailosaurException

Permanently delete a device. This operation cannot be undone.

Parameters:

deviceId - The unique identifier of the device.

Throws:

MailosaurException - Thrown if Mailosaur responds with an error.