com.facebook.api
Enum ApplicationProperty

java.lang.Object
  extended by java.lang.Enum<ApplicationProperty>
      extended by com.facebook.api.ApplicationProperty
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<ApplicationProperty>

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

An enumeration for managing the different application properties that Facebook supports. These properties can be managed using the admin.* API calls. For more details, see: http://wiki.developers.facebook.com/index.php/ApplicationProperties

Author:
aroth

Enum Constant Summary
ABOUT_URL
          This is the URL to your application's About page.
APPLICATION_NAME
          The name of your app
CALLBACK_URL
          Your app's callback URL (100 char max)
CANVAS_NAME
          canvas_name.
DASHBOARD_URL
          Facebook won't say.
DEFAULT_COLUMN
          Default column on the user's profile page to show the app in
DEFAULT_FBML
          Default FBML markup to show on the user's profile page
DESCRIPTION
          Description of your app.
DESKTOP
          Specifies that your app is a desktop app
DEV_MODE
          Indicates whether developer mode is enabled (1) or disabled (0).
EDIT_URL
          Facebook won't say.
EMAIL
          The email address associated with the application; the email address Facebook uses to contact you about your application.
HELP_URL
          The URL to your application's help page
ICON_URL
          icon_url.
INSTALLABLE
          Indicates whether a user can (1) or cannot (0) install your application.
IP_LIST
          List of IP addresses allowed to make requests to Facebook using your API key.
IS_MOBILE
          Specifies that your app can support mobile devices
LOGO_URL
          logo_url
MESSAGE_ACTION
          For applications that can create attachments, this is the label for the action that creates the attachment.
MESSAGE_URL
          For applications that can create attachments, this is the URL where you store the attachment's content.
POST_INSTALL_URL
          The URL where a user gets redirected after installing your application.
PRELOAD_FQL
          "A preloaded FQL query".
PRIVACY_URL
          The URL to your application's privacy terms.
PRIVATE_INSTALL
          Indicates whether you want to disable (1) or enable (0) News Feed and Mini-Feed stories when a user installs your application.
SEE_ALL_URL
          Facebook won't say.
TOS_URL
          The URL to your application's Terms of Service.
UNINSTALL_URL
          The URL where a user gets redirected after removing your application.
USE_IFRAME
          Specifies that your app renders in an iframe
 
Field Summary
protected static java.util.Map<java.lang.String,ApplicationProperty> PROP_TABLE
          A map of property names to their associated ApplicationProperty value
 
Method Summary
 java.lang.String getName()
          Gets the name by which Facebook refers to this property.
static ApplicationProperty getProperty(java.lang.String name)
           
static ApplicationProperty getPropertyForString(java.lang.String propName)
          Lookup an ApplicationProperty value by its name.
 java.lang.String getType()
          Gets the type which Facebook assigns to this property.
 boolean isBooleanProperty()
           
 boolean isName(java.lang.String name)
          Returns true if this field has a particular name.
 boolean isStringProperty()
           
 java.lang.String propertyName()
           
 java.lang.String toString()
           
static ApplicationProperty valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static ApplicationProperty[] 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, valueOf
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

APPLICATION_NAME

public static final ApplicationProperty APPLICATION_NAME
The name of your app


CALLBACK_URL

public static final ApplicationProperty CALLBACK_URL
Your app's callback URL (100 char max)


POST_INSTALL_URL

public static final ApplicationProperty POST_INSTALL_URL
The URL where a user gets redirected after installing your application. The post-install URL cannot be longer than 100 characters


EDIT_URL

public static final ApplicationProperty EDIT_URL
Facebook won't say.


DASHBOARD_URL

public static final ApplicationProperty DASHBOARD_URL
Facebook won't say.


UNINSTALL_URL

public static final ApplicationProperty UNINSTALL_URL
The URL where a user gets redirected after removing your application.


IP_LIST

public static final ApplicationProperty IP_LIST
List of IP addresses allowed to make requests to Facebook using your API key.


EMAIL

public static final ApplicationProperty EMAIL
The email address associated with the application; the email address Facebook uses to contact you about your application. (default value is your Facebook email address.)


DESCRIPTION

public static final ApplicationProperty DESCRIPTION
Description of your app.


USE_IFRAME

public static final ApplicationProperty USE_IFRAME
Specifies that your app renders in an iframe


DESKTOP

public static final ApplicationProperty DESKTOP
Specifies that your app is a desktop app


IS_MOBILE

public static final ApplicationProperty IS_MOBILE
Specifies that your app can support mobile devices


DEFAULT_FBML

public static final ApplicationProperty DEFAULT_FBML
Default FBML markup to show on the user's profile page


DEFAULT_COLUMN

public static final ApplicationProperty DEFAULT_COLUMN
Default column on the user's profile page to show the app in


MESSAGE_URL

public static final ApplicationProperty MESSAGE_URL
For applications that can create attachments, this is the URL where you store the attachment's content.


MESSAGE_ACTION

public static final ApplicationProperty MESSAGE_ACTION
For applications that can create attachments, this is the label for the action that creates the attachment. It cannot be more than 20 characters.


ABOUT_URL

public static final ApplicationProperty ABOUT_URL
This is the URL to your application's About page. About pages are now Facebook Pages.


PRIVATE_INSTALL

public static final ApplicationProperty PRIVATE_INSTALL
Indicates whether you want to disable (1) or enable (0) News Feed and Mini-Feed stories when a user installs your application. (default value is 1)


INSTALLABLE

public static final ApplicationProperty INSTALLABLE
Indicates whether a user can (1) or cannot (0) install your application. (default value is 1)


PRIVACY_URL

public static final ApplicationProperty PRIVACY_URL
The URL to your application's privacy terms.


HELP_URL

public static final ApplicationProperty HELP_URL
The URL to your application's help page


SEE_ALL_URL

public static final ApplicationProperty SEE_ALL_URL
Facebook won't say.


TOS_URL

public static final ApplicationProperty TOS_URL
The URL to your application's Terms of Service.


DEV_MODE

public static final ApplicationProperty DEV_MODE
Indicates whether developer mode is enabled (1) or disabled (0). Only developers can install applications in developer mode. (default value is 1)


PRELOAD_FQL

public static final ApplicationProperty PRELOAD_FQL
"A preloaded FQL query".


CANVAS_NAME

public static final ApplicationProperty CANVAS_NAME
canvas_name.


ICON_URL

public static final ApplicationProperty ICON_URL
icon_url.


LOGO_URL

public static final ApplicationProperty LOGO_URL
logo_url

Field Detail

PROP_TABLE

protected static final java.util.Map<java.lang.String,ApplicationProperty> PROP_TABLE
A map of property names to their associated ApplicationProperty value

Method Detail

values

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

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

valueOf

public static ApplicationProperty 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 property. The name is what is sent in API calls and other requests to Facebook to specify the desired property.

Returns:
the Facebook name given to this property.

getType

public java.lang.String getType()
Gets the type which Facebook assigns to this property. The returned value will be "string" for string-typed properties, and "bool" for boolean typed properties.

Returns:
the type Facebook gives to this property.

getPropertyForString

public static ApplicationProperty getPropertyForString(java.lang.String propName)
Lookup an ApplicationProperty value by its name.

Parameters:
propName - the name to lookup
Returns:
the ApplicationProperty value that corresponds to the specified name, or null if the name cannot be found/is not valid.

getProperty

public static ApplicationProperty getProperty(java.lang.String name)

propertyName

public java.lang.String propertyName()

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Enum<ApplicationProperty>

isBooleanProperty

public boolean isBooleanProperty()

isStringProperty

public boolean isStringProperty()

isName

public boolean isName(java.lang.String name)
Returns true if this field has a particular name.



Copyright © 2008. All Rights Reserved.