com.cryptshare.api

Class CheckVerificationResult

java.lang.Object

com.cryptshare.api.CheckVerificationResult

public class CheckVerificationResult
extends java.lang.Object

Provides information about the verification of a user for the current client.

Constructor Summary

Constructors

Constructor and Description
CheckVerificationResult(VerificationMode verificationMode, boolean userVerified, boolean quickEnabled, boolean activationRequired, java.util.Map<java.util.Locale,java.lang.String> administratorActivationContactDetails, java.util.List<ClientInformation> quickEnabledClients, int activationCodeLength, boolean clientVerificationAllowed) Constructor.

Method Summary

Modifier and Type	Method and Description
int	getActivationCodeLength() Returns the fixed length of the activation codes that are used for QUICK access activation.
java.util.Map<java.util.Locale,java.lang.String>	getAdministratorActivationContactDetails() Returns a Map with administrator activation contact details by language.
java.util.List<ClientInformation>	getQuickEnabledClients() Returns ClientInformation objects, one for each QUICK-enabled client known by the server.
VerificationMode	getVerificationMode() Returns the VerificationMode that is set by the server for the current product.
boolean	isActivationRequired() Returns whether an activation process is required for the user on this client to use QUICK.
boolean	isClientVerificationAllowed() Returns whether the current Client allows verifications of mode VerificationMode.CLIENT.
boolean	isQuickEnabled() Returns whether the requesting user is already enabled for QUICK on this client.
boolean	isUserVerified() Returns whether the requesting user is already verified or not.

Methods inherited from class java.lang.Object

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

Constructor Detail

CheckVerificationResult

public CheckVerificationResult(VerificationMode verificationMode,
                               boolean userVerified,
                               boolean quickEnabled,
                               boolean activationRequired,
                               java.util.Map<java.util.Locale,java.lang.String> administratorActivationContactDetails,
                               java.util.List<ClientInformation> quickEnabledClients,
                               int activationCodeLength,
                               boolean clientVerificationAllowed)

Constructor.

Parameters:

verificationMode - The VerificationMode that is set by the server for the current product.

userVerified - Whether the requesting user is already verified or not.

quickEnabled - Whether the requesting user is already enabled for QUICK on this client.

activationRequired - Whether an activation process is required for the user on this client to use QUICK.

administratorActivationContactDetails - A Map with administrator activation contact details by language.

quickEnabledClients - ClientInformation objects, one for each QUICK-enabled client known by the server.

activationCodeLength - The fixed length of the activation codes that are used for QUICK access activation.

clientVerificationAllowed - Whether the current Client allows verifications of mode VerificationMode.CLIENT.

Method Detail

isClientVerificationAllowed

public boolean isClientVerificationAllowed()

Returns whether the current Client allows verifications of mode VerificationMode.CLIENT.

Returns:

true, if the server allows client verification mode for this client, false otherwise.

getVerificationMode

public VerificationMode getVerificationMode()

Returns the VerificationMode that is set by the server for the current product.

Returns:

The verification mode.

isUserVerified

public boolean isUserVerified()

Returns whether the requesting user is already verified or not.

Returns:

True, if the requesting user is already verified, false otherwise.

isQuickEnabled

public boolean isQuickEnabled()

Returns whether the requesting user is already enabled for QUICK on this client. This can only be true if isUserVerified() is also true.

Returns:

True, if the requesting user is verified and already enabled for QUICK on this client, false otherwise.

isActivationRequired

public boolean isActivationRequired()

Returns whether an activation process is required for the user on this client to use QUICK. This is the case if the requesting user not enabled for QUICK on this client, but has used QUICK previously on other clients.

Returns:

True, if the user is verified and an action process is required, false otherwise.

getActivationCodeLength

public int getActivationCodeLength()

Returns the fixed length of the activation codes that are used for QUICK access activation. The value is always 0 if isActivationRequired() is false.

Returns:

The activation code length.

getAdministratorActivationContactDetails

public java.util.Map<java.util.Locale,java.lang.String> getAdministratorActivationContactDetails()

Returns a Map with administrator activation contact details by language. The language is specified as Locale. The map is always empty if isActivationRequired() is false.

Returns:

The administrator activation contact details by language.

getQuickEnabledClients

public java.util.List<ClientInformation> getQuickEnabledClients()

Returns ClientInformation objects, one for each QUICK-enabled client known by the server. This may include the current client. The list is always empty if isActivationRequired() is false.

Returns:

A list of ClientInformations.