ApplicationProperties

From Facebook Developer Wiki

Jump to: navigation, search

Description

This article lists all Facebook Developer application properties currently accessible through the Facebook API.

You set the properties with admin.setAppProperties and get them with admin.getAppProperties. Some properties are noted as read-only, so you can get them only, and cannot set them.

Note: These methods are currently in beta.

Parameters

RequiredNameTypeDescription
optional about_url string This is the URL to your application's About page. About pages are now Facebook Pages.
app_id string Your application ID. (This is a read-only property that cannot be set.)
application_name string The name of your application.
authorize_url string The URL Facebook pings after a user authorizes your application. The URL cannot be longer than 100 characters.
base_domain string The base domain for a Facebook Connect application. See Base Domain.
callback_url string Your application's callback URL. The callback URL cannot be longer than 100 characters.
canvas_name string The canvas name of your application.
connect_logo_url string The URL to your site's Facebook Connect logo.
connect_reclaim_url string 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 string The main URL for a Facebook Connect application.
contact_email string The email address through which your users can contact you. (Default value is your Facebook email address.)
dashboard_url string This is the URL to your application from its bookmark on the Applications menu.
default_column bool Indicates whether your application appears in the wide (1) or narrow (0) column of a user's Boxes tab. (Default value is 1.)
description string The description of your application.
desktop bool Indicates whether your application is Web-based (0) or gets installed on a user's desktop (1). (Default value is 1.)
dev_mode bool Indicates whether developer mode is enabled (1) or disabled (0). Only developers can install applications in developer mode. (Default value is 1.)
edit_url string 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 string 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 string The URL to your application's help page.
icon_url string The URL to your application's icon.
iframe_enable_util bool For iframe applications, indicates whether the iframe is resizable (1) or smartsized (0). (Default value is 1.)
ignore_ip_whitelist_for_ss bool 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 string 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 bool Indicates whether a user can (1) or cannot (0) install your application. (Default value is 1.)
ip_list string 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 bool Indicates whether your application can run on a mobile device (1) or not (0). (Default value is 1.)
logo_url string A URL for your application's logo, as shown in product directory and search listings.
message_action string 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 string For applications that can create attachments, this is the URL where you store the attachment's content.
post_authorize_redirect_url string 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 string A preloaded FQL query.
privacy_url string The URL to your application's privacy terms.
private_install bool 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 string 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 string The label for the link on a friend's profile to an application's Publisher content.
publish_self_action string The label for the link on user's own profile to an application's Publisher content.
publish_self_url string 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 string 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 bool Indicates whether Quick Transitions are enabled (1) or disabled (0). (Default value is 1.)
tab_default_name string The default label for an application tab when a user first adds it to his or her profile.
targeted bool 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 string The URL to your application's Terms of Service.
uninstall_url string The URL that Facebook pings after a user removes your application.
use_iframe bool Indicates whether you render your application with FBML (0) or in an iframe (1). (Default value is 1.)
video_rentals bool 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 bool Indicates whether to use the profile's full canvas width, which is for backwards compatibility.
reference