io.realm.mongodb

Enum Credentials.Provider

java.lang.Object

java.lang.Enum<Credentials.Provider>

io.realm.mongodb.Credentials.Provider

All Implemented Interfaces:

Serializable, Comparable<Credentials.Provider>

Enclosing class:

Credentials

public static enum Credentials.Provider
extends Enum<Credentials.Provider>

This enum contains the list of identity providers supported by MongoDB Realm. All of these except EMAIL_PASSWORD must be enabled manually on MongoDB Realm to work.

See Also:

Authentication Providers

Enum Constant Summary

Enum Constants

Enum Constant and Description
ANONYMOUS
API_KEY
APPLE
CUSTOM_FUNCTION
EMAIL_PASSWORD
FACEBOOK
GOOGLE
JWT
UNKNOWN

Method Summary

Modifier and Type	Method and Description
static Credentials.Provider	fromId(String id) Create the identity provider from the ID string returned by MongoDB Realm.
String	getId() Return the string presentation of this identity provider.
static Credentials.Provider	valueOf(String name) Returns the enum constant of this type with the specified name.
static Credentials.Provider[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ANONYMOUS

public static final Credentials.Provider ANONYMOUS

API_KEY

public static final Credentials.Provider API_KEY

APPLE

public static final Credentials.Provider APPLE

CUSTOM_FUNCTION

public static final Credentials.Provider CUSTOM_FUNCTION

EMAIL_PASSWORD

public static final Credentials.Provider EMAIL_PASSWORD

FACEBOOK

public static final Credentials.Provider FACEBOOK

GOOGLE

public static final Credentials.Provider GOOGLE

JWT

public static final Credentials.Provider JWT

UNKNOWN

public static final Credentials.Provider UNKNOWN

Method Detail

values

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

Returns:

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

valueOf

public static Credentials.Provider valueOf(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:

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

NullPointerException - if the argument is null

fromId

public static Credentials.Provider fromId(String id)

Create the identity provider from the ID string returned by MongoDB Realm.

Parameters:

id - the string identifier for the provider

Returns:

the enum representing the provider or UNKNOWN if no matching provider was found.

getId

public String getId()

Return the string presentation of this identity provider.