com.google.code.facebookapi
Enum FacebookParam

java.lang.Object
  java.lang.Enum<FacebookParam>
      com.google.code.facebookapi.FacebookParam

All Implemented Interfaces:

java.io.Serializable, java.lang.CharSequence, java.lang.Comparable<FacebookParam>

public enum FacebookParam
extends java.lang.Enum<FacebookParam>
implements java.lang.CharSequence

List of URL parameters added by Facebook.

See Also:

http://wiki.developers.facebook.com/index.php/Authorizing_Applications

Enum Constant Summary

ADDED

API_KEY

CANVAS_USER

EXPIRES

EXT_PERMS

FRIENDS

IN_CANVAS

IN_IFRAME

IN_NEW_FACEBOOK

IN_PROFILE_TAB

IS_ADMIN

IS_FAN

LOCALE

MESSAGE

PAGE_ADDED

PAGE_ID

POSITION_FIX

PROFILE_SESSION_KEY

PROFILE_UPDATE_TIME

PROFILE_USER

REQUEST_METHOD

SESSION_KEY

SIGNATURE

SMS

SMS_NEW_USER

SMS_SID

SS

TIME

TYPE

UNINSTALL

USER

Method Summary

char	charAt(int index)
static FacebookParam	get(java.lang.String key) Retrieves the FacebookParam corresponding to the supplied String key.
java.lang.String	getSignatureName()
static boolean	isInNamespace(java.lang.String key) Indicates whether a given key is in the FacebookParam namespace
static boolean	isSignature(java.lang.String key) Check to see if a given parameter name is a signature parameter.
int	length()
static java.lang.String	stripSignaturePrefix(java.lang.String paramName) Remove the Facebook signature prefix from the specified parameter.
java.lang.CharSequence	subSequence(int start, int end)
java.lang.String	toString()
static FacebookParam	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static FacebookParam[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SIGNATURE

public static final FacebookParam SIGNATURE

ADDED

public static final FacebookParam ADDED

API_KEY

public static final FacebookParam API_KEY

FRIENDS

public static final FacebookParam FRIENDS

LOCALE

public static final FacebookParam LOCALE

TIME

public static final FacebookParam TIME

USER

public static final FacebookParam USER

CANVAS_USER

public static final FacebookParam CANVAS_USER

SESSION_KEY

public static final FacebookParam SESSION_KEY

EXPIRES

public static final FacebookParam EXPIRES

PROFILE_UPDATE_TIME

public static final FacebookParam PROFILE_UPDATE_TIME

EXT_PERMS

public static final FacebookParam EXT_PERMS

IN_CANVAS

public static final FacebookParam IN_CANVAS

IN_PROFILE_TAB

public static final FacebookParam IN_PROFILE_TAB

PROFILE_USER

public static final FacebookParam PROFILE_USER

PROFILE_SESSION_KEY

public static final FacebookParam PROFILE_SESSION_KEY

PAGE_ID

public static final FacebookParam PAGE_ID

PAGE_ADDED

public static final FacebookParam PAGE_ADDED

REQUEST_METHOD

public static final FacebookParam REQUEST_METHOD

IN_NEW_FACEBOOK

public static final FacebookParam IN_NEW_FACEBOOK

IN_IFRAME

public static final FacebookParam IN_IFRAME

IS_ADMIN

public static final FacebookParam IS_ADMIN

IS_FAN

public static final FacebookParam IS_FAN

TYPE

public static final FacebookParam TYPE

SS

public static final FacebookParam SS

SMS

public static final FacebookParam SMS

MESSAGE

public static final FacebookParam MESSAGE

SMS_SID

public static final FacebookParam SMS_SID

SMS_NEW_USER

public static final FacebookParam SMS_NEW_USER

POSITION_FIX

public static final FacebookParam POSITION_FIX

UNINSTALL

public static final FacebookParam UNINSTALL

Method Detail

values

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

Returns:

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

valueOf

public static FacebookParam 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

get

public static FacebookParam get(java.lang.String key)

Retrieves the FacebookParam corresponding to the supplied String key.

Parameters:

key - a possible FacebookParam

Returns:

the matching FacebookParam or null if there's no match

isInNamespace

public static boolean isInNamespace(java.lang.String key)

Indicates whether a given key is in the FacebookParam namespace

Parameters:

key -

Returns:

boolean

isSignature

public static boolean isSignature(java.lang.String key)

Check to see if a given parameter name is a signature parameter.

Parameters:

key - the parameter name to check

Returns:

true if the parameter is a signature parameter false otherwise

charAt

public char charAt(int index)

Specified by:

charAt in interface java.lang.CharSequence

length

public int length()

Specified by:

length in interface java.lang.CharSequence

subSequence

public java.lang.CharSequence subSequence(int start,
                                          int end)

Specified by:

subSequence in interface java.lang.CharSequence

toString

public java.lang.String toString()

Specified by:

toString in interface java.lang.CharSequence

Overrides:

toString in class java.lang.Enum<FacebookParam>

getSignatureName

public java.lang.String getSignatureName()

Returns:

the signature name of this parameter

stripSignaturePrefix

public static java.lang.String stripSignaturePrefix(java.lang.String paramName)

Remove the Facebook signature prefix from the specified parameter.

Parameters:

paramName - the name to remove the prefix from.

Returns:

the specified name, with the Facebook signature prefix removed, if necessary.