com.google.code.facebookapi
Enum ApplicationProperty

java.lang.Object
  java.lang.Enum<ApplicationProperty>
      com.google.code.facebookapi.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 Also:

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

Enum Constant Summary

ABOUT_URL
This is the URL to your application's About page.

APP_ID
Your application ID.

APPLICATION_NAME
The name of your application.

AUTHORIZE_URL
The URL.

BASE_DOMAIN
The base domain for a Facebook Connect application.

CALLBACK_URL
Your application's callback URL.

CANVAS_NAME
The canvas name of your application.

CONNECT_LOGO_URL
The URL to your site's Facebook Connect logo.

CONNECT_RECLAIM_URL
For Facebook Connect sites, the URL you can provide to reclaim an account from a user who deactivated his or her Facebook account.

CONNECT_URL
The main URL for a Facebook Connect application.

CONTACT_EMAIL
contact_email

DASHBOARD_URL
This is the URL to your application from its bookmark on the Applications menu.

DEFAULT_COLUMN
Indicates whether your application appears in the wide (1) or narrow (0) column of a user's Facebook profile.

DESCRIPTION
The description of your application.

DESKTOP
Indicates whether your application is Web-based (0) or gets installed on a user's desktop (1).

DEV_MODE
Indicates whether developer mode is enabled (1) or disabled (0).

EDIT_URL
The URL to the Edit link displayed on your application's profile box.

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
The URL to your application's icon.

IFRAME_ENABLE_UTIL
For iframe applications, indicates whether the iframe is resizable (1) or smartsized (0).

IGNORE_IP_WHITELIST_FOR_SS
Indicates whether an iframe application or Facebook Connect site can (1) or cannot (0) bypass a server whitelist.

INFO_CHANGED_URL
The URL to ping if a user changes the content of your application info section.

INSTALLABLE
Indicates whether a user can (1) or cannot (0) install your application.

IP_LIST
For Web-based applications, these are the IP addresses of your servers that can access Facebook's servers and serve information to your application.

IS_MOBILE
Indicates whether your application can run on a mobile device (1) or not (0).

LOGO_URL
A URL for your application's logo, as shown in product directory and search listings.

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_AUTHORIZE_REDIRECT_URL
The URL where a user gets redirected after authorizing 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.

PROFILE_TAB_URL
The URL from where Facebook fetches the content for an application tab.

PUBLISH_ACTION
The label for the link on a friend's profile to an application's Publisher content.

PUBLISH_SELF_ACTION
The label for the link on user's own profile to an application's Publisher content.

PUBLISH_SELF_URL
The URL from which to fetch your application content for use in the Publisher when the user is publishing on her own profile.

PUBLISH_URL
The URL from which to fetch your application content for use in the Publisher when the user is publishing on a friend's profile.

QUICK_TRANSITIONS
Indicates whether Quick Transitions are enabled (1) or disabled (0).

TAB_DEFAULT_NAME
The default label for an application tab when a user first adds it to his or her profile.

TARGETED
If set to true, indicates that Demographic Restrictions have been set for your application; if false, then the restrictions were never set or were removed.

TOS_URL
The URL to your application's Terms of Service.

UNINSTALL_URL
The URL that Facebook pings after a user removes your application.

USE_IFRAME
Indicates whether you render your application with FBML (0) or in an iframe (1).

VIDEO_RENTALS
Indicates whether your application or site publishes Feed stories about video sales (1) or not (0) -- this is for Video Privacy Protection Act conformance.

WIDE_MODE
Indicates whether to use the profile's full canvas width, which is for backwards compatibility.

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 propertyName) 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 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

ABOUT_URL

public static final ApplicationProperty ABOUT_URL

This is the URL to your application's About page. About pages are now Facebook Pages.

APP_ID

public static final ApplicationProperty APP_ID

Your application ID. (This is a read-only property that cannot be set.)

APPLICATION_NAME

public static final ApplicationProperty APPLICATION_NAME

The name of your application.

AUTHORIZE_URL

public static final ApplicationProperty AUTHORIZE_URL

The URL. Facebook pings after a user authorizes your application. The URL cannot be longer than 100 characters.

BASE_DOMAIN

public static final ApplicationProperty BASE_DOMAIN

The base domain for a Facebook Connect application. See Base Domain.

CALLBACK_URL

public static final ApplicationProperty CALLBACK_URL

Your application's callback URL. The callback URL cannot be longer than 100 characters.

CANVAS_NAME

public static final ApplicationProperty CANVAS_NAME

The canvas name of your application. (this is a read-only property that cannot be set)

CONNECT_LOGO_URL

public static final ApplicationProperty CONNECT_LOGO_URL

The URL to your site's Facebook Connect logo. (this is a read-only property that cannot be set)

CONNECT_RECLAIM_URL

public static final ApplicationProperty CONNECT_RECLAIM_URL

For Facebook Connect sites, the URL you can provide to reclaim an account from a user who deactivated his or her Facebook account.

CONNECT_URL

public static final ApplicationProperty CONNECT_URL

The main URL for a Facebook Connect application.

CONTACT_EMAIL

public static final ApplicationProperty CONTACT_EMAIL

contact_email

DASHBOARD_URL

public static final ApplicationProperty DASHBOARD_URL

This is the URL to your application from its bookmark on the Applications menu.

DEFAULT_COLUMN

public static final ApplicationProperty DEFAULT_COLUMN

Indicates whether your application appears in the wide (1) or narrow (0) column of a user's Facebook profile. (Default value is 1.)

DESCRIPTION

public static final ApplicationProperty DESCRIPTION

The description of your application.

DESKTOP

public static final ApplicationProperty DESKTOP

Indicates whether your application is Web-based (0) or gets installed on a user's desktop (1). (Default value is 1.)

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)

EDIT_URL

public static final ApplicationProperty EDIT_URL

The URL to the Edit link displayed on your application's profile box. An admin of a Facebook Page that has added your application can follow the URL to edit the application settings for the Page.

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.)

HELP_URL

public static final ApplicationProperty HELP_URL

The URL to your application's help page

ICON_URL

public static final ApplicationProperty ICON_URL

The URL to your application's icon. (this is a read-only property that cannot be set)

IFRAME_ENABLE_UTIL

public static final ApplicationProperty IFRAME_ENABLE_UTIL

For iframe applications, indicates whether the iframe is resizable (1) or smartsized (0). (Default value is 1.)

IGNORE_IP_WHITELIST_FOR_SS

public static final ApplicationProperty IGNORE_IP_WHITELIST_FOR_SS

Indicates whether an iframe application or Facebook Connect site can (1) or cannot (0) bypass a server whitelist. (Default value is 1.)

INFO_CHANGED_URL

public static final ApplicationProperty INFO_CHANGED_URL

The URL to ping if a user changes the content of your application info section. Your application can get new content for the section, and set it with profile.setInfo.

INSTALLABLE

public static final ApplicationProperty INSTALLABLE

Indicates whether a user can (1) or cannot (0) install your application. (Default value is 1)

IP_LIST

public static final ApplicationProperty IP_LIST

For Web-based applications, these are the IP addresses of your servers that can access Facebook's servers and serve information to your application.

IS_MOBILE

public static final ApplicationProperty IS_MOBILE

Indicates whether your application can run on a mobile device (1) or not (0). (Default value is 1.)

LOGO_URL

public static final ApplicationProperty LOGO_URL

A URL for your application's logo, as shown in product directory and search listings. (this is a read-only property that cannot be set)

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.

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.

POST_AUTHORIZE_REDIRECT_URL

public static final ApplicationProperty POST_AUTHORIZE_REDIRECT_URL

The URL where a user gets redirected after authorizing your application. If not set, the user will continue on to the page that they were originally going to.

PRELOAD_FQL

public static final ApplicationProperty PRELOAD_FQL

A preloaded FQL query.

PRIVACY_URL

public static final ApplicationProperty PRIVACY_URL

The URL to your application's privacy terms.

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)

PROFILE_TAB_URL

public static final ApplicationProperty PROFILE_TAB_URL

The URL from where Facebook fetches the content for an application tab. The URL should be relative to your canvas page URL at Facebook.

PUBLISH_ACTION

public static final ApplicationProperty PUBLISH_ACTION

The label for the link on a friend's profile to an application's Publisher content.

PUBLISH_SELF_ACTION

public static final ApplicationProperty PUBLISH_SELF_ACTION

The label for the link on user's own profile to an application's Publisher content.

PUBLISH_SELF_URL

public static final ApplicationProperty PUBLISH_SELF_URL

The URL from which to fetch your application content for use in the Publisher when the user is publishing on her own profile.

PUBLISH_URL

public static final ApplicationProperty PUBLISH_URL

The URL from which to fetch your application content for use in the Publisher when the user is publishing on a friend's profile.

QUICK_TRANSITIONS

public static final ApplicationProperty QUICK_TRANSITIONS

Indicates whether Quick Transitions are enabled (1) or disabled (0). (Default value is 1.)

TAB_DEFAULT_NAME

public static final ApplicationProperty TAB_DEFAULT_NAME

The default label for an application tab when a user first adds it to his or her profile.

TARGETED

public static final ApplicationProperty TARGETED

If set to true, indicates that Demographic Restrictions have been set for your application; if false, then the restrictions were never set or were removed.

TOS_URL

public static final ApplicationProperty TOS_URL

The URL to your application's Terms of Service.

UNINSTALL_URL

public static final ApplicationProperty UNINSTALL_URL

The URL that Facebook pings after a user removes your application.

USE_IFRAME

public static final ApplicationProperty USE_IFRAME

Indicates whether you render your application with FBML (0) or in an iframe (1). (Default value is 1.)

VIDEO_RENTALS

public static final ApplicationProperty VIDEO_RENTALS

Indicates whether your application or site publishes Feed stories about video sales (1) or not (0) -- this is for Video Privacy Protection Act conformance. (This is a read-only property that can only be set via the application settings editor.)

WIDE_MODE

public static final ApplicationProperty WIDE_MODE

Indicates whether to use the profile's full canvas width, which is for backwards compatibility.

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

Returns:

an array containing the constants of this enum type, in the order they are 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

java.lang.NullPointerException - if the argument is null

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 propertyName)

Returns true if this field has a particular name.