com.baasbox.android

Enum BaasUser.Scope

java.lang.Object

java.lang.Enum<BaasUser.Scope>

com.baasbox.android.BaasUser.Scope

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<BaasUser.Scope>

Enclosing class:

BaasUser

public static enum BaasUser.Scope
extends java.lang.Enum<BaasUser.Scope>

Scopes of visibility of user related data.

See Also:

BaasUser.getScope(com.baasbox.android.BaasUser.Scope)

Enum Constant Summary

Enum Constants

Enum Constant and Description
FRIEND Scope used to access a JsonObject whose fields are accessible by the friends of the user
PRIVATE Scope used to access a JsonObject of user private data
PUBLIC Scope used to access a JsonObject whose fields are accessible by anyone without authentication
REGISTERED Scope used to access a JsonObject whose fields are accessible by any registered user.

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	visibility The actual name of the scope

Method Summary

Modifier and Type	Method and Description
static BaasUser.Scope	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static BaasUser.Scope[]	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

PRIVATE

public static final BaasUser.Scope PRIVATE

Scope used to access a JsonObject of user private data

FRIEND

public static final BaasUser.Scope FRIEND

Scope used to access a JsonObject whose fields are accessible by the friends of the user

REGISTERED

public static final BaasUser.Scope REGISTERED

Scope used to access a JsonObject whose fields are accessible by any registered user.

PUBLIC

public static final BaasUser.Scope PUBLIC

Scope used to access a JsonObject whose fields are accessible by anyone without authentication

Field Detail

visibility

public final java.lang.String visibility

The actual name of the scope

Method Detail

values

public static BaasUser.Scope[] 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 (BaasUser.Scope c : BaasUser.Scope.values())
    System.out.println(c);

Returns:

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

valueOf

public static BaasUser.Scope 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