com.stackmob.sdk.api
Enum StackMob.OAuthVersion

java.lang.Object
  extended by java.lang.Enum<StackMob.OAuthVersion>
      extended by com.stackmob.sdk.api.StackMob.OAuthVersion
All Implemented Interfaces:
Serializable, Comparable<StackMob.OAuthVersion>
Enclosing class:
StackMob

public static enum StackMob.OAuthVersion
extends Enum<StackMob.OAuthVersion>

The two different OAuth versions the SDK can use for authentication. The Push API currently only supports OAuth1 and will use that regardless of which OAuth version you're using.


Enum Constant Summary
One
          OAuth1 uses a private key embedded in your app to authenticate.
Two
          OAuth2 authenticates individual users and allows user-based roles and access permissions.
 
Method Summary
static StackMob.OAuthVersion valueOf(String name)
          Returns the enum constant of this type with the specified name.
static StackMob.OAuthVersion[] 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

One

public static final StackMob.OAuthVersion One
OAuth1 uses a private key embedded in your app to authenticate. Apps authenticated like this have authorization overriding any Access Controls you may have set up. This setting is recommended for admin consoles only, and not for production apps.


Two

public static final StackMob.OAuthVersion Two
OAuth2 authenticates individual users and allows user-based roles and access permissions.

Method Detail

values

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

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

valueOf

public static StackMob.OAuthVersion 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


Copyright © 2013 StackMob. All Rights Reserved.