Enum FacebookPermissions
- All Implemented Interfaces:
Serializable
,Comparable<FacebookPermissions>
,java.lang.constant.Constable
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantDescriptionProvides the ability to both read and manage the ads for ad accounts you have access to.Provides the access to Ads Insights API to pull ads report information for ad accounts you have access to.Read and write with Business Management APIGrants your app the ability to create, read, update, and delete business owned product catalogs that the user is an admin of.Provides access to the person's primary email address via the email property on the user object.Gives your app the ability to receive member-related data on group content when a member has granted the app permission to do so.Provides the ability to read Instagram accounts you have access to.Provides the ability to publish content to Instagram account you have access to.Provides the ability to read Instagram accounts you have access to.Provides the ability to read insights of Instagram account you have access to.The instagram_manage_messages permission allows business users to read and respond to Instagram Direct messages.Grants your app permission to retrieve all the information captured within a lead.Deprecated.Thepages_manage_ads
permission allows your app the ability to manage ads associated with the Page.Provides the access to manage call to actions of the Pages that you manage.Thepages_manage_engagement
permission allows your app the ability to create, edit, and delete comments posted on the Page.Lets your app manage Instant Articles on behalf of Facebook Pages administered by people using your app.Provides access to manage leads retrieved from Lead Ads of the Pages that you manage.Thepages_manage_metadata
permission allows you to subscribe and receive webhooks about activity on the Page, and to update settings on the Page.Thepages_manage_posts
permission allows your app the ability to create, edit, and delete your Page posts.This allows you to send and receive messages through a Facebook Page.This allows you to charge users in Messenger conversations on behalf of pages.This allows you to send and receive messages through a Facebook Page.This allows you to send and receive messages through a Facebook Page out of the 24h window opened by a user action.Thepages_read_engagement
permission allows your app the ability to read content (posts, photos, videos, events) posted by the Page, read followers data including name, PSID, and profile picture, and read metadata and other insights about the Page.Thepages_read_user_content
permission allows your app the ability to read User generated content on the Page, such as posts, comments, and ratings by Users or other Pages, and to delete User comments on Page posts.Provides the access to show the list of the Pages that you manage.Provides access to a subset of items that are part of a person's public profile.Deprecated.this permission is deprecated and it is not possible to publish anything to the user feed via Graph API since April 2018Deprecated.Gives an app the ability to post content into a group on behalf of a user who has granted the app this permission.Grants an app permission to publish live videos to the app User's timeline.Provides read-only access to the Audience Network Insights data for Apps the person owns.Deprecated.since breaking change on 4 April, 2018Deprecated.not usable since Graph API 2.3, useREAD_CUSTOM_FRIENDLISTS
instead.Provides read-only access to the Insights data for Pages, Apps and web domains the person owns.Provides the ability to read from the Page Inboxes of the Pages managed by a person.Provides the ability to set a person's attendee status on Facebook Events (eg attending, maybe, or declined).Deprecated.since breaking change on 4 April, 2018Deprecated.since breaking change on 4 April, 2018Deprecated.since breaking change on 4 April, 2018Deprecated.since breaking change on 4 April, 2018Deprecated.since breaking change on 4 April, 2018Deprecated.since breaking change on 4 April, 2018Provides access to a person's age range.Access the date and month of a person's birthday.Deprecated.since breaking change on 4 April, 2018Provides read-only access to the Events a person is hosting or has RSVP'd to.Provides access the list of friends that also use your app.Deprecated.since breaking change on 4 April, 2018Provides access to a person's gender.Provides access to a person's hometown location through the hometown field on the User object.Provides access to the list of all Facebook Pages and Open Graph objects that a person has liked.Provides access to the Facebook profile URL for another user of the app.Provides access to a person's current city through the location field on the User object.Enables your app to read the Groups a person is an admin of through the groups edge on the User object.Provides access to the photos a person has uploaded or been tagged in.Provides access to the posts on a person's Timeline.Deprecated.since breaking change on 4 April, 2018Deprecated.since breaking change on 4 April, 2018Deprecated.since breaking change on 4 April, 2018Provides access to the Places a person has been tagged at in photos, videos, statuses and links.Provides access to the videos a person has uploaded or been tagged in.Deprecated.since breaking change on 4 April, 2018Deprecated.since breaking change on 4 April, 2018Provides the ability to read and/or manage WhatsApp business assets you own or have been granted access to by other businesses through this permission. -
Method Summary
Modifier and TypeMethodDescriptionstatic FacebookPermissions
Returns the enum constant of this type with the specified name.static FacebookPermissions[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
Enum Constant Details
-
PUBLIC_PROFILE
Provides access to a subset of items that are part of a person's public profile. A person's public profile refers to the following properties on the user object by default:- id
- name
- first_name
- last_name
- link
- gender
- locale
- timezone
- updated_time
- verified
gender & locale can only be accessed if:- The person queried is the person using the app.
- The person queried is using the app, and is a friend of the person using the app.
- The person queried is using the app, is not a friend of the person using the app, but the app includes either
an app access token or an
appsecret_proof
argument with the call.
Review Your app may use this permission without review from Facebook. -
USER_ABOUT_ME
Deprecated.since breaking change on 4 April, 2018Provides access to a person's personal description (the 'About Me' section on their Profile) through the bio property on the User object.This permission does not give access to a person's public profile data. A person's name, profile picture, locale, age range and gender are included by default with the public_profile permission.
Review
If your app requests this permission Facebook will have to review how your app uses it.
-
USER_ACTIONS_BOOKS
Deprecated.since breaking change on 4 April, 2018Provides access to all common books actions published by any app the person has used. This includes books they've read, want to read, rated or quoted.Review
If your app requests this permission Facebook will have to review how your app uses it.
-
USER_ACTIONS_FITNESS
Deprecated.since breaking change on 4 April, 2018Provides access to all common Open Graph fitness actions published by any app the person has used. This includes runs, walks and bikes actions.Review
If your app requests this permission Facebook will have to review how your app uses it.
-
USER_ACTIONS_MUSIC
Deprecated.since breaking change on 4 April, 2018Provides access to all common Open Graph music actions published by any app the person has used. This includes songs they've listened to, and playlists they've created.Review
If your app requests this permission Facebook will have to review how your app uses it.
-
USER_ACTIONS_NEWS
Deprecated.since breaking change on 4 April, 2018Provides access to all common Open Graph news actions published by any app the person has used which publishes these actions. This includes news articles they've read or news articles they've published.Review
If your app requests this permission Facebook will have to review how your app uses it.
-
USER_ACTIONS_VIDEO
Deprecated.since breaking change on 4 April, 2018Provides access to all common Open Graph video actions published by any app the person has used which publishes these actions. This includes videos they've watched, videos they've rated and videos they want to watch.Review
If your app requests this permission Facebook will have to review how your app uses it.
-
USER_AGE_RANGE
Provides access to a person's age range.Review
If your app requests this permission Facebook will have to review how your app uses it.
-
USER_BIRTHDAY
Access the date and month of a person's birthday. This may or may not include the person's year of birth, dependent upon their privacy settings and the access token being used to query this field.Please note most integrations will only need age_range which comes as part of the public_profile permission.
Review
If your app requests this permission Facebook will have to review how your app uses it.
-
USER_EDUCATION_HISTORY
Deprecated.since breaking change on 4 April, 2018Provides access to a person's education history through the education field on the User object.Review
If your app requests this permission Facebook will have to review how your app uses it.
-
USER_EVENTS
Provides read-only access to the Events a person is hosting or has RSVP'd to.Review
If your app requests this permission Facebook will have to review how your app uses it.
-
USER_FRIENDS
Provides access the list of friends that also use your app. These friends can be found on the friends edge on the user object.In order for a person to show up in one person's friend list, both people must have decided to share their list of friends with your app and not disabled that permission during login. Also both friends must have been asked for
user_friends
during the login process.Review
Your app may use this permission without review from Facebook.
-
USER_GAMES_ACTIVITY
Deprecated.since breaking change on 4 April, 2018Provides access to read a person's game activity (scores, achievements) in any game the person has played.Review
If your app requests this permission Facebook will have to review how your app uses it.
-
USER_GENDER
Provides access to a person's gender.Review
If your app requests this permission Facebook will have to review how your app uses it.
-
USER_HOMETOWN
Provides access to a person's hometown location through the hometown field on the User object. This is set by the user on the Profile.Review
If your app requests this permission Facebook will have to review how your app uses it.
-
USER_LIKES
Provides access to the list of all Facebook Pages and Open Graph objects that a person has liked. This list is available through the likes edge on the User object.Review
If your app requests this permission Facebook will have to review how your app uses it.
-
USER_LINK
Provides access to the Facebook profile URL for another user of the app.Review
If your app requests this permission Facebook will have to review how your app uses it.
-
USER_LOCATION
Provides access to a person's current city through the location field on the User object. The current city is set by a person on their Profile.The current city is not necessarily the same as a person's hometown.
Review
If your app requests this permission Facebook will have to review how your app uses it.
-
USER_MANAGED_GROUPS
Enables your app to read the Groups a person is an admin of through the groups edge on the User object.This permission does not allow you to create groups on behalf of a person. It is not possible to create groups via the Graph API. This does not let you read the groups a user is just a member of.
This permission is being deprecated as Groups is moving to a new permission model for apps. Please continue to use
user_managed_groups
for testing your apps in dev mode. However, when submitting for review, please select the reviewable feature Groups API, and do not submit thisuser_managed_groups
in your review.Limited use: for testing only
-
USER_PHOTOS
Provides access to the photos a person has uploaded or been tagged in. This is available through the photos edge on the User object.Review
If your app requests this permission Facebook will have to review how your app uses it.
-
USER_POSTS
Provides access to the posts on a person's Timeline.Includes their own posts, posts they are tagged in, and posts other people make on their Timeline.
Review
If your app requests this permission Facebook will have to review how your app uses it.
- Since:
- 1.10.0
-
USER_RELATIONSHIP_DETAILS
Deprecated.since breaking change on 4 April, 2018Provides access to a person's relationship interests as theinterested_in
field on the User object.Review
If your app requests this permission Facebook will have to review how your app uses it.
-
USER_RELATIONSHIPS
Deprecated.since breaking change on 4 April, 2018Provides access to a person's relationship status, significant other and family members as fields on the User object.Review
If your app requests this permission Facebook will have to review how your app uses it.
-
USER_RELIGION_POLITICS
Deprecated.since breaking change on 4 April, 2018Provides access to a person's religious and political affiliations.Review
If your app requests this permission Facebook will have to review how your app uses it.
-
USER_TAGGED_PLACES
Provides access to the Places a person has been tagged at in photos, videos, statuses and links.Review
If your app requests this permission Facebook will have to review how your app uses it.
-
USER_VIDEOS
Provides access to the videos a person has uploaded or been tagged in.Review
If your app requests this permission Facebook will have to review how your app uses it.
-
USER_WEBSITE
Deprecated.since breaking change on 4 April, 2018Provides access to the person's personal website URL via the website field on the User object.Review
If your app requests this permission Facebook will have to review how your app uses it.
-
USER_WORK_HISTORY
Deprecated.since breaking change on 4 April, 2018Provides access to a person's work history and list of employers via thework
field on the User object.Review
If your app requests this permission Facebook will have to review how your app uses it.
-
ADS_MANAGEMENT
Provides the ability to both read and manage the ads for ad accounts you have access to. Please see Ads Management for details. -
ADS_READ
Provides the access to Ads Insights API to pull ads report information for ad accounts you have access to. -
EMAIL
Provides access to the person's primary email address via the email property on the user object.Do not spam users. Your use of email must comply with both Facebook policies and with the CAN-SPAM Act.
Note, even if you request the email permission it is not guaranteed you will get an email address. For example, if someone signed up for Facebook with a phone number instead of an email address, the email field may be empty.
Review
Your app may use this permission without review from Facebook.
-
MANAGE_PAGES
Deprecated.Enables your app to retrieve Page Access Tokens for the Pages and Apps that the person administrates.Review
If your app requests this permission Facebook will have to review how your app uses it. You can grant this permission on behalf of people listed within the Roles section of your App's Dashboard without review by Facebook.
-
PAGES_MANAGE_ADS
Thepages_manage_ads
permission allows your app the ability to manage ads associated with the Page.You can use this permission to create and manage ads for the Page.
Review
If your app requests this permission Facebook will have to review how your app uses it.
-
PAGES_MANAGE_METADATA
Thepages_manage_metadata
permission allows you to subscribe and receive webhooks about activity on the Page, and to update settings on the Page.You can use this permission if you need it to help the Page Admin administer and manage the Page.
Review
If your app requests this permission Facebook will have to review how your app uses it.
-
PAGES_READ_ENGAGEMENT
Thepages_read_engagement
permission allows your app the ability to read content (posts, photos, videos, events) posted by the Page, read followers data including name, PSID, and profile picture, and read metadata and other insights about the Page.You can use this permission if you need it to help the Page Admin administer and manage the Page.
Review
If your app requests this permission Facebook will have to review how your app uses it.
-
PAGES_READ_USER_CONTENT
Thepages_read_user_content
permission allows your app the ability to read User generated content on the Page, such as posts, comments, and ratings by Users or other Pages, and to delete User comments on Page posts.It also allows your app to read posts that the Page is tagged in.
You can use this permission to read Users and other Page’s content posted on the Page if you need it to help manage the Page.
Review
If your app requests this permission Facebook will have to review how your app uses it.
-
PAGES_MANAGE_CTA
Provides the access to manage call to actions of the Pages that you manage.Review
If your app requests this permission Facebook will have to review how your app uses it.
-
PAGES_MANAGE_INSTANT_ARTICLES
Lets your app manage Instant Articles on behalf of Facebook Pages administered by people using your app.Review
If your app requests this permission Facebook will have to review how your app uses it.
-
PAGES_MANAGE_LEADS
Provides access to manage leads retrieved from Lead Ads of the Pages that you manage.Review
If your app requests this permission Facebook will have to review how your app uses it.
-
PAGES_MESSAGING
This allows you to send and receive messages through a Facebook Page.This permission cannot be used to send promotional or advertising content. Conversations through this API can only begin when someone indicates—through a Messenger plugin or directly messaging you—that they want to receive messages from you.
Review
If your app requests this permission Facebook will have to review how your app uses it.
-
PAGES_MESSAGING_PHONE_NUMBER
This allows you to send and receive messages through a Facebook Page.This permission cannot be used to send promotional or advertising content. Conversations through this API can only begin when someone indicates—through a Messenger plugin or directly messaging you—that they want to receive messages from you.
Review
If your app requests this permission Facebook will have to review how your app uses it.
-
PAGES_SHOW_LIST
Provides the access to show the list of the Pages that you manage.Review
If your app requests this permission Facebook will have to review how your app uses it.
-
PUBLISH_ACTIONS
Deprecated.this permission is deprecated and it is not possible to publish anything to the user feed via Graph API since April 2018Provides access to publish Posts, Open Graph actions, achievements, scores and other activity on behalf of a person using your app.Because this permission lets you publish on behalf of a user please read the Platform Policies to ensure you understand how to properly use this permission.
Your app does not need to request the publish_actions permission in order to use the Feed Dialog, the Requests Dialog or the Send Dialog
Review
If your app requests this permission Facebook will have to review how your app uses it.
-
PUBLISH_PAGES
Deprecated.Gives your app the ability to post, comment and like as any of the Pages managed by a person using your app.Publishing as an individual personal account is not possible with this permission. To post as an individual, please see the
publish_actions
permission.Review
If your app requests this permission Facebook will have to review how your app uses it.
-
PAGES_MANAGE_POSTS
Thepages_manage_posts
permission allows your app the ability to create, edit, and delete your Page posts.If you have access to
pages_read_user_content
, you can also usepages_manage_posts
to delete Page posts created by a User.You can use this permission to create and delete content on the Page.
Review
If your app requests this permission Facebook will have to review how your app uses it.
-
PAGES_MANAGE_ENGAGEMENT
Thepages_manage_engagement
permission allows your app the ability to create, edit, and delete comments posted on the Page.If you have access to
pages_read_user_content
, you can also usepages_manage_engagement
to delete comments posted by other Pages.It also allows your app the ability to create and delete your own Page's likes to Page content.
You can use this permission if you need it to help manage and moderate content on the Page.
Review
If your app requests this permission Facebook will have to review how your app uses it.
-
PUBLISH_TO_GROUPS
Gives an app the ability to post content into a group on behalf of a user who has granted the app this permission.Review
If your app requests this permission Facebook will have to review how your app uses it.
-
PUBLISH_VIDEO
Grants an app permission to publish live videos to the app User's timeline.Review
If your app requests this permission Facebook will have to review how your app uses it.
-
GROUPS_ACCESS_MEMBER_INFO
Gives your app the ability to receive member-related data on group content when a member has granted the app permission to do so.Review
If your app requests this permission Facebook will have to review how your app uses it.
-
READ_AUDIENCE_NETWORK_INSIGHTS
Provides read-only access to the Audience Network Insights data for Apps the person owns.Review
If your app requests this permission Facebook will have to review how your app uses it.
-
READ_FRIENDLISTS
Deprecated.not usable since Graph API 2.3, useREAD_CUSTOM_FRIENDLISTS
instead. If you use the Graph API before 2.3 ignore the deprecation warningProvides access to the names of custom lists a person has created to organize their friends. This is useful for rendering an audience selector when someone is publishing stories to Facebook from your app.This permission does not give access to a list of person's friends. If you want to access a person's friends who also use your app, you should use the user_friends permission.
This permission will also not help you invite a person's friends to use your app.
Review
If your app requests this permission Facebook will have to review how your app uses it.
-
READ_CUSTOM_FRIENDLISTS
Deprecated.since breaking change on 4 April, 2018Provides access to the names of custom lists a person has created to organize their friends.This is useful for rendering an audience selector when someone is publishing stories to Facebook from your app.
This permission does not give access to a list of person's friends. If you want to access a person's friends who also use your app, you should use the user_friends permission.
This permission will also not help you invite a person's friends to use your app.
This permission was called
read_friendlists
before v2.3.Review
If your app requests this permission Facebook will have to review how your app uses it.
-
READ_INSIGHTS
Provides read-only access to the Insights data for Pages, Apps and web domains the person owns.Review
If your app requests this permission Facebook will have to review how your app uses it.
-
READ_PAGE_MAILBOXES
Provides the ability to read from the Page Inboxes of the Pages managed by a person. This permission is often used alongside the manage_pages permission.This permission does not let your app read the page owner's mailbox. It only applies to the page's mailbox.
Review
If your app requests this permission Facebook will have to review how your app uses it.
-
RSVP_EVENT
Provides the ability to set a person's attendee status on Facebook Events (eg attending, maybe, or declined).This permission does not let you invite people to an event.
This permission does not let you update an event's details.
This permission does not let you create an event. There is no way to create an event via the API as of Graph API v2.0.
Review
If your app requests this permission Facebook will have to review how your app uses it.
-
BUSINESS_MANAGEMENT
Read and write with Business Management APIReview
If your app requests this permission Facebook will have to review how your app uses it.
-
CATALOG_MANAGEMENT
Grants your app the ability to create, read, update, and delete business owned product catalogs that the user is an admin of. This permission grants access to related endpoints. By default, your app may only access product catalogs that are owned by admins of the app when in developer mode.Review
If your app requests this permission Facebook will have to review how your app uses it.
-
LEADS_RETRIEVAL
Grants your app permission to retrieve all the information captured within a lead.Review
If your app requests this permission Facebook will have to review how your app uses it.
-
PAGES_MESSAGING_SUBSCRIPTIONS
This allows you to send and receive messages through a Facebook Page out of the 24h window opened by a user action.This permission cannot be used to send promotional or advertising content.
Review
If your app requests this permission Facebook will have to review how your app uses it.
-
PAGES_MESSAGING_PAYMENTS
This allows you to charge users in Messenger conversations on behalf of pages.Intended for tangible goods only, not virtual or subscriptions.
Review
If your app requests this permission Facebook will have to review how your app uses it.
-
INSTAGRAM_BASIC
Provides the ability to read Instagram accounts you have access to.Please see Instagram's Getting Started Guide for details.
Review
If your app requests this permission Facebook will have to review how your app uses it.
-
INSTAGRAM_MANAGE_COMMENTS
Provides the ability to read Instagram accounts you have access to.Please see Instagram's Getting Started Guide for details.
Review
If your app requests this permission Facebook will have to review how your app uses it.
-
INSTAGRAM_MANAGE_INSIGHTS
Provides the ability to read insights of Instagram account you have access to.Please see Instagram's Getting Started Guide for details.
Review
If your app requests this permission Facebook will have to review how your app uses it.
-
INSTAGRAM_MANAGE_MESSAGES
The instagram_manage_messages permission allows business users to read and respond to Instagram Direct messages.Please see Instagram's Getting Started Guide for details.
Review
If your app requests this permission Facebook will have to review how your app uses it.
-
INSTAGRAM_CONTENT_PUBLISH
Provides the ability to publish content to Instagram account you have access to.Please see Instagram's reference for details.
Review
If your app requests this permission Facebook will have to review how your app uses it.
-
WHATSAPP_BUSINESS_MANAGEMENT
Provides the ability to read and/or manage WhatsApp business assets you own or have been granted access to by other businesses through this permission. These business assets include WhatsApp business accounts, phone numbers, and message templates.Please see Whatsapps's reference for details.
Review
If your app requests this permission Facebook will have to review how your app uses it.
-
-
Method Details
-
values
Returns an array containing the constants of this enum type, in the order they are declared.- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
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:
IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is null
-
getPermissionString
-
getCategory
-