com.google.code.facebookapi
Enum Permission

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

All Implemented Interfaces:

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

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

Enum for managing the different permission-types used by Facebook. These are opt-in permissions that the user must explicitly grant, and can only be requested one at a time. To request that a user grant you a permission, direct them to a URL of the form: http://www.facebook.com/authorize.php?api_key=[YOUR_API_KEY]&v=1.0&ext_perm=[PERMISSION NAME] You can query to see if the user has granted your application a given permission using the 'users.hasAppPermission' API call.

Enum Constant Summary

MARKETPLACE_CREATE
Permission to create marketplac elistings for the user

PHOTO_UPLOAD
Enahnced photo-uploading permissions

SMS_SEND
Permission to send SMS messages to a user

STATUS_UPDATE
Permission to update a user's status message

Field Summary

static java.lang.String

PERM_AUTHORIZE_ADDR The unchanging part of the URL to use when authorizing permissions.

Method Summary

static java.lang.String	authorizationUrl(java.lang.String apiKey, Permission permission) Compute the URL to which to send the user to request the extended permission.
java.lang.String	getName() Gets the name by which Facebook refers to this permission.
static Permission	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Permission[]	values() Returns an array containing the constants of this enum type, in the order they're declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SMS_SEND

public static final Permission SMS_SEND

Permission to send SMS messages to a user

STATUS_UPDATE

public static final Permission STATUS_UPDATE

Permission to update a user's status message

MARKETPLACE_CREATE

public static final Permission MARKETPLACE_CREATE

Permission to create marketplac elistings for the user

PHOTO_UPLOAD

public static final Permission PHOTO_UPLOAD

Enahnced photo-uploading permissions

Field Detail

PERM_AUTHORIZE_ADDR

public static final java.lang.String PERM_AUTHORIZE_ADDR

The unchanging part of the URL to use when authorizing permissions.

See Also:

Constant Field Values

Method Detail

values

public static final Permission[] values()

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

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

Returns:

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

valueOf

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

getName

public java.lang.String getName()

Gets the name by which Facebook refers to this permission. The name is what is sent in API calls and other requests to Facebook to specify the desired premission.

Returns:

the Facebook name given to this permission.

authorizationUrl

public static java.lang.String authorizationUrl(java.lang.String apiKey,
                                                Permission permission)

Compute the URL to which to send the user to request the extended permission.

Parameters:

apiKey - your application's API key.

permission - the permission you want the grant URL for.

Returns:

a String that specifies the URL to direct users to in order to grant this permission to the application.