ch.privately.core

Enum PrivatelyCore

java.lang.Object

java.lang.Enum<PrivatelyCore>

ch.privately.core.PrivatelyCore

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<PrivatelyCore>

public enum PrivatelyCore
extends java.lang.Enum<PrivatelyCore>

Enum handling basic functionalities shared across Privately SDKs, such as authentication.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PrivatelyCore.AuthenticationCallback Interface for the callback executed when the authentication call completes.

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE

Method Summary

Modifier and Type	Method and Description
void	authenticate(java.lang.String apiKey, java.lang.String secretKey, PrivatelyCore.AuthenticationCallback callback) Authenticate the library and any Privately SDKs.
java.lang.String	getApiKey()
void	init(Context context) Initialisation, must be called before using any method on the instance.
boolean	isAuthenticated()
static PrivatelyCore	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static PrivatelyCore[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INSTANCE

public static final PrivatelyCore INSTANCE

Method Detail

values

public static PrivatelyCore[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (PrivatelyCore c : PrivatelyCore.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static PrivatelyCore valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

init

public void init(Context context)

Initialisation, must be called before using any method on the instance.

Parameters:

context -

authenticate

public void authenticate(java.lang.String apiKey,
                         java.lang.String secretKey,
                         PrivatelyCore.AuthenticationCallback callback)
                  throws java.lang.IllegalStateException

Authenticate the library and any Privately SDKs. Must be called before using any Privately libraries.

Parameters:

apiKey - The client API key.

secretKey - The client secret.

callback - A callback executed when the authentication call completes.

Throws:

java.lang.IllegalStateException - when the instance hasn't been initialised.

isAuthenticated

public boolean isAuthenticated()

Returns:

`true` if the SDK is authenticated, `false` otherwise.

getApiKey

public java.lang.String getApiKey()

Returns:

The API key used for authentication, if any, `null` otherwise.