Package com.restfb.scope

Enum FacebookPermissions

java.lang.Object
java.lang.Enum<FacebookPermissions>
com.restfb.scope.FacebookPermissions
All Implemented Interfaces:
Serializable, Comparable<FacebookPermissions>, java.lang.constant.Constable
public enum FacebookPermissions extends Enum<FacebookPermissions>
Please check the permission dependencies here

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static enum 
    FacebookPermissions.Category
     

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    ADS_MANAGEMENT
    Provides the ability to both read and manage the ads for ad accounts you have access to.
    ADS_READ
    Provides the access to Ads Insights API to pull ads report information for ad accounts you have access to.
    ATTRIBUTION_READ
    The attribution_read permission grants your app access to the Attribution API to pull attribution report data for lines of business you own or have been granted access to by the owner or owners of other lines of business.
    BUSINESS_MANAGEMENT
    Read and write with Business Management API
    CATALOG_MANAGEMENT
    Grants your app the ability to create, read, update, and delete business owned product catalogs that the user is an admin of.
    COMMERCE_ACCOUNT_MANAGE_ORDERS
    The commerce_account manage_orders permission allows your app to read and update commerce account orders.
    COMMERCE_ACCOUNT_READ_ORDERS
    The commerce_account_read_orders permission allows your app to read commerce account orders.
    COMMERCE_ACCOUNT_READ_REPORTS
    The commerce_account_read_reports permission allows your app to read finance reporting data to build custom tax, cash reconciliation and reimbursement reports for a commerce account.
    COMMERCE_ACCOUNT_READ_SETTINGS
    The commerce_account_read_settings permission allows your app to read commerce account settings.
    COMMERCE_MANAGE_ACCOUNTS
    The commerce_manage_accounts permission allows your app to create and manage commerce accounts, such as an ecommerce app
    EMAIL
    Provides access to the person's primary email address via the email property on the user object.
    GAMING_USER_LOCALE
    The gaming_user_locale permission allows your app to get a user's preferred language while the user plays a game on Facebook (for example, Instant Games or Cloud Gaming).
    GROUPS_ACCESS_MEMBER_INFO
    Deprecated.
    no longer supported with Graph API 19.0 or after 22.
    INSTAGRAM_BASIC
    Provides the ability to read Instagram accounts you have access to.
    INSTAGRAM_BRANDED_CONTENT_ADS_BRAND
    The instagram_branded_content_ads_brand permission allows an app to read Instagram posts where the app user's Instagram account is tagged as a paid partner, and an app user to read, request, and revoke permissions to run Partnership Ads.
    INSTAGRAM_BRANDED_CONTENT_BRAND
    The instagram_branded_content_brand permission allows your app to add, remove and view creators from a specific brand’s approved creators list.
    INSTAGRAM_BRANDED_CONTENT_CREATOR
    The instagram_branded_content_creator permission allows your app to read and change the boost status of a creator’s specific piece of content.
    INSTAGRAM_BUSINESS_BASIC
     
    INSTAGRAM_BUSINESS_CONTENT_PUBLISH
     
    INSTAGRAM_BUSINESS_MANAGE_COMMENTS
     
    INSTAGRAM_BUSINESS_MANAGE_MESSAGES
     
    INSTAGRAM_CONTENT_PUBLISH
    Provides the ability to publish content to Instagram account you have access to.
    INSTAGRAM_GRAPH_USER_MEDIA
    The instagram_graph_user_media permission allows your app to read the Media node, which represents an image, video, or album and the node’s edges.
    INSTAGRAM_GRAPH_USER_PROFILE
    The instagram_graph_user_profile permission allows your app to read the app user's profile.
    INSTAGRAM_MANAGE_COMMENTS
    Provides the ability to read Instagram accounts you have access to.
    INSTAGRAM_MANAGE_EVENTS
    The instagram_manage_events permission allows an app permission to log events (e.g., purchase, add-to-cart, leads) on behalf of Instagram accounts administered by the app’s users.
    INSTAGRAM_MANAGE_INSIGHTS
    Provides the ability to read insights of Instagram account you have access to.
    INSTAGRAM_MANAGE_MESSAGES
    The instagram_manage_messages permission allows business users to read and respond to Instagram Direct messages.
    INSTAGRAM_SHOPPING_TAG_PRODUCTS
    The instagram_shopping_tag_products permission allows an app to tag Instagram media with product tags and appeal product rejections.
    LEADS_RETRIEVAL
    Grants your app permission to retrieve all the information captured within a lead.
    PAGES_EVENTS
    The page_events permissions allows your app permission to log events on behalf of Facebook Pages administered by people using your app and to send those events to Facebook for ads targeting, optimization and reporting.
    PAGES_MANAGE_ADS
    The pages_manage_ads permission allows your app the ability to manage ads associated with the Page.
    PAGES_MANAGE_CTA
    Provides the access to manage call to actions of the Pages that you manage.
    PAGES_MANAGE_ENGAGEMENT
    The pages_manage_engagement permission allows your app the ability to create, edit, and delete comments posted on the Page.
    PAGES_MANAGE_INSTANT_ARTICLES
    Lets your app manage Instant Articles on behalf of Facebook Pages administered by people using your app.
    PAGES_MANAGE_LEADS
    Provides access to manage leads retrieved from Lead Ads of the Pages that you manage.
    PAGES_MANAGE_METADATA
    The pages_manage_metadata permission allows you to subscribe and receive webhooks about activity on the Page, and to update settings on the Page.
    PAGES_MANAGE_POSTS
    The pages_manage_posts permission allows your app the ability to create, edit, and delete your Page posts.
    PAGES_MESSAGING
    This allows you to send and receive messages through a Facebook Page.
    PAGES_MESSAGING_PAYMENTS
    This allows you to charge users in Messenger conversations on behalf of pages.
    PAGES_MESSAGING_PHONE_NUMBER
    This allows you to send and receive messages through a Facebook Page.
    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.
    PAGES_READ_ENGAGEMENT
    The pages_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.
    PAGES_READ_USER_CONTENT
    The pages_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.
    PAGES_SHOW_LIST
    Provides the access to show the list of the Pages that you manage.
    PAGES_USER_GENDER
    The pages_user_gender permission allows your app to access a user's gender through the Page your app is connected to.
    PAGES_USER_LOCALE
    The pages_user_locale permission allows your to app to a user's locale through the Page your app is connected to.
    PAGES_USER_TIMEZONE
    The pages_user_timezone permission grants your app access to a user's time zone through the Page your app is connected to.
    PRIVATE_COMPUTATION_ACCESS
    The private_computation_access permission allows an app to access the Meta Private Computation products.
    PUBLIC_PROFILE
    Provides access to a subset of items that are part of a person's public profile.
    PUBLISH_TO_GROUPS
    Deprecated.
    no longer supported with Graph API 19.0 or after 22.
    PUBLISH_VIDEO
    Grants an app permission to publish live videos to the app User's timeline.
    READ_AUDIENCE_NETWORK_INSIGHTS
    Provides read-only access to the Audience Network Insights data for Apps the person owns.
    READ_INSIGHTS
    The read_insights permission allows your app to read the Insights data for Pages, apps and web domains the person owns.
    RESEARCH_APIS
    The research_apis permission allows your app to access data on public Facebook Pages, Groups, and Events within the Facebook Open Research and Transparency Tool.
    RSVP_EVENT
    Provides the ability to set a person's attendee status on Facebook Events (eg attending, maybe, or declined).
    THREADS_BASIC
    Required for making any calls to all Threads API endpoints
    THREADS_CONTENT_PUBLISH
    Required for Threads publishing endpoints only
    THREADS_MANAGE_INSIGHTS
    Required for making GET calls to insights endpoints
    THREADS_MANAGE_REPLIES
    Required for making POST calls to reply endpoints
    THREADS_READ_REPLIES
    Required for making GET calls to reply endpoints
    USER_AGE_RANGE
    Provides access to a person's age range.
    USER_BIRTHDAY
    Access the date and month of a person's birthday.
    USER_EVENTS
    Provides read-only access to the Events a person is hosting or has RSVP'd to.
    USER_FRIENDS
    Provides access the list of friends that also use your app.
    USER_GENDER
    Provides access to a person's gender.
    USER_HOMETOWN
    Provides access to a person's hometown location through the hometown field on the User object.
    USER_LIKES
    Provides access to the list of all Facebook Pages and Open Graph objects that a person has liked.
    USER_LINK
    Provides access to the Facebook profile URL for another user of the app.
    USER_LOCATION
    Provides access to a person's current city through the location field on the User object.
    USER_MANAGED_GROUPS
    Enables your app to read the Groups a person is an admin of through the groups edge on the User object.
    USER_MEDIA
    The user_media permission allows your app to read the Media node, which represents an image, video, or album and the node’s edges using the Instagram Basic Display API.
    USER_MESSENGER_CONTACT
    The user_messenger_contact permission allows a business to contact a person via Messenger upon their approval or initiation of a chat thread with the business's Page.
    USER_PHOTOS
    Provides access to the photos a person has uploaded or been tagged in.
    USER_POSTS
    Provides access to the posts on a person's Timeline.
    USER_PROFILE
    The user_profile permission allows your app to read the app user's profile using the Instagram Basic Display API.
    USER_TAGGED_PLACES
    Provides access to the Places a person has been tagged at in photos, videos, statuses and links.
    USER_VIDEOS
    Provides access to the videos a person has uploaded or been tagged in.
    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.
    WHATSAPP_BUSINESS_MESSAGING
    The `whatsapp_business_messaging` permission allows an app to send WhatsApp messages to a specific phone number, upload and retrieve media from messages, manage and get WhatsApp business profile information, and to register those phone numbers with Meta.

  • Method Summary

    Modifier and Type
    Method
    Description
    FacebookPermissions.Category
    getCategory()
     
    String
    getPermissionString()
     
    static FacebookPermissions
    valueOf(String name)
    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.

    Methods inherited from class java.lang.Enum

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

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • PUBLIC_PROFILE

      public static final FacebookPermissions 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
      On the web, public_profile is implied with every request and isn't required, although the best practice is to declare it. On iOS and Android, you must manually request it as part of your login flow.

      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_AGE_RANGE

      @GraphAPI(since="3.0") public static final FacebookPermissions 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

      public static final FacebookPermissions 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_EVENTS

      public static final FacebookPermissions 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

      public static final FacebookPermissions 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_GENDER

      @GraphAPI(since="3.0") public static final FacebookPermissions 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

      public static final FacebookPermissions 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

      public static final FacebookPermissions 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_LOCATION

      public static final FacebookPermissions 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

      public static final FacebookPermissions 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 this user_managed_groups in your review.

      Limited use: for testing only

    • USER_MESSENGER_CONTACT

      public static final FacebookPermissions USER_MESSENGER_CONTACT
      The user_messenger_contact permission allows a business to contact a person via Messenger upon their approval or initiation of a chat thread with the business's Page.

      The allowed usage for this permission is for a Page to send a person an initial message, post—purchase updates and account updates.

      Review

      If your app requests this permission Facebook will have to review how your app uses it.

    • USER_PHOTOS

      public static final FacebookPermissions 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

      public static final FacebookPermissions 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_TAGGED_PLACES

      public static final FacebookPermissions 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

      public static final FacebookPermissions 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.

    • ADS_MANAGEMENT

      public static final FacebookPermissions 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

      public static final FacebookPermissions ADS_READ
      Provides the access to Ads Insights API to pull ads report information for ad accounts you have access to.

    • ATTRIBUTION_READ

      public static final FacebookPermissions ATTRIBUTION_READ
      The attribution_read permission grants your app access to the Attribution API to pull attribution report data for lines of business you own or have been granted access to by the owner or owners of other lines of business.

      Allowed Usage

      Provides the ability for your app to access ads performance data from Attribution for use in custom dashboards and data analytics.

    • EMAIL

      public static final FacebookPermissions 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.

    • PAGES_EVENTS

      public static final FacebookPermissions PAGES_EVENTS
      The page_events permissions allows your app permission to log events on behalf of Facebook Pages administered by people using your app and to send those events to Facebook for ads targeting, optimization and reporting.

      Allowed Usage

      Send businesses related activities (for example purchase, add-to-cart, lead) on behalf of Pages owned by the people who use your app.

    • PAGES_MANAGE_ADS

      public static final FacebookPermissions PAGES_MANAGE_ADS
      The pages_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.

      Since:
      June 1, 2020

    • PAGES_MANAGE_METADATA

      public static final FacebookPermissions PAGES_MANAGE_METADATA
      The pages_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.

      Since:
      June 1, 2020

    • PAGES_READ_ENGAGEMENT

      public static final FacebookPermissions PAGES_READ_ENGAGEMENT
      The pages_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.

      Since:
      June 1, 2020

    • PAGES_READ_USER_CONTENT

      public static final FacebookPermissions PAGES_READ_USER_CONTENT
      The pages_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.

      Since:
      June 1, 2020

    • PAGES_MANAGE_CTA

      @GraphAPI(since="2.5") public static final FacebookPermissions 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

      @GraphAPI(since="2.5") public static final FacebookPermissions 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

      @GraphAPI(since="2.3") public static final FacebookPermissions 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

      @GraphAPI(since="2.6") public static final FacebookPermissions 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

      @GraphAPI(since="2.6") public static final FacebookPermissions 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

      @GraphAPI(since="2.5") public static final FacebookPermissions 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.

    • PAGES_USER_GENDER

      public static final FacebookPermissions PAGES_USER_GENDER
      The pages_user_gender permission allows your app to access a user's gender through the Page your app is connected to.

      Allowed Usage

      • Personalize experiences or recommendations based on gender.
      • Use gendered language such as correct pronouns and titles.

    • PAGES_USER_LOCALE

      public static final FacebookPermissions PAGES_USER_LOCALE
      The pages_user_locale permission allows your to app to a user's locale through the Page your app is connected to.

      Allowed Usage

      • Personalize experiences based on the locale of a person by surfacing locale specific content.
      • Send responses in the preferred language of the person.
      • Display numbers, times, and dates correctly for the locale of the person.

    • PAGES_USER_TIMEZONE

      public static final FacebookPermissions PAGES_USER_TIMEZONE
      The pages_user_timezone permission grants your app access to a user's time zone through the Page your app is connected to.

      Allowed Usage

      • Prevent messages from being sent at an inconvenient time.
      • Send time sensitive content or recurring news at a specific time.
      • Provide tailored content based on time.
      • Send time appropriate greetings.

    • PAGES_MANAGE_POSTS

      public static final FacebookPermissions PAGES_MANAGE_POSTS
      The pages_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 use pages_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.

      Since:
      June 1, 2020

    • PAGES_MANAGE_ENGAGEMENT

      public static final FacebookPermissions PAGES_MANAGE_ENGAGEMENT
      The pages_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 use pages_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.

      Since:
      June 1, 2020

    • PRIVATE_COMPUTATION_ACCESS

      public static final FacebookPermissions PRIVATE_COMPUTATION_ACCESS
      The private_computation_access permission allows an app to access the Meta Private Computation products.

      Allowed Usage

      • Monitor private attribution datasets for a business.
      • Monitor instances for private attribution datasets for a business.
      • Create and manage instances for private attribution datasets for a business.

    • PUBLISH_TO_GROUPS

      @GraphAPI(since="3.0", until="19.0") @Deprecated public static final FacebookPermissions PUBLISH_TO_GROUPS
      Deprecated.
      no longer supported with Graph API 19.0 or after 22. April 2024
      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

      @GraphAPI(since="3.1") public static final FacebookPermissions 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

      @GraphAPI(since="3.0", until="19.0") @Deprecated public static final FacebookPermissions GROUPS_ACCESS_MEMBER_INFO
      Deprecated.
      no longer supported with Graph API 19.0 or after 22. April 2024
      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

      @GraphAPI(since="2.4") public static final FacebookPermissions 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.

    • RESEARCH_APIS

      public static final FacebookPermissions RESEARCH_APIS
      The research_apis permission allows your app to access data on public Facebook Pages, Groups, and Events within the Facebook Open Research and Transparency Tool.

      Allowed Usage

      Utilize public Facebook data for academic research.

    • READ_INSIGHTS

      public static final FacebookPermissions READ_INSIGHTS
      The read_insights permission allows your app to read the Insights data for Pages, apps and web domains the person owns.

      Allowed Usage

      • Integrate Facebook's app, page or domain insights into your own analytics tools..

    • RSVP_EVENT

      public static final FacebookPermissions 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

      public static final FacebookPermissions BUSINESS_MANAGEMENT
      Read and write with Business Management API

      Review

      If your app requests this permission Facebook will have to review how your app uses it.

    • CATALOG_MANAGEMENT

      public static final FacebookPermissions 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.

    • GAMING_USER_LOCALE

      public static final FacebookPermissions GAMING_USER_LOCALE
      The gaming_user_locale permission allows your app to get a user's preferred language while the user plays a game on Facebook (for example, Instant Games or Cloud Gaming).

      Allowed Usage

      Display a game interface in the user's preferred language.

    • LEADS_RETRIEVAL

      @GraphAPI(since="3.1") public static final FacebookPermissions 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

      @GraphAPI(since="2.6") public static final FacebookPermissions 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

      @GraphAPI(since="2.6") public static final FacebookPermissions 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

      @GraphAPI(since="2.5") public static final FacebookPermissions 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

      @GraphAPI(since="2.5") public static final FacebookPermissions 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_EVENTS

      public static final FacebookPermissions INSTAGRAM_MANAGE_EVENTS
      The instagram_manage_events permission allows an app permission to log events (e.g., purchase, add-to-cart, leads) on behalf of Instagram accounts administered by the app’s users. The allowed usage for this permission is to log events on Instagram accounts and send this activity data to Meta for ads targeting, optimization and reporting; and to provide marketing and advertising analytics insights. You may also use this permission to request analytics insights to improve your app and for marketing or advertising purposes, through the use of aggregated and de-identified or anonymized information (provided such data cannot be re-identified).

      Allowed Usage

      • Get metadata of an Instagram Business account.
      • Get data insights of an Instagram Business account.
      • Get story insights of an Instagram Business account.

    • INSTAGRAM_MANAGE_INSIGHTS

      @GraphAPI(since="2.5") public static final FacebookPermissions 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

      public static final FacebookPermissions 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_SHOPPING_TAG_PRODUCTS

      public static final FacebookPermissions INSTAGRAM_SHOPPING_TAG_PRODUCTS
      The instagram_shopping_tag_products permission allows an app to tag Instagram media with product tags and appeal product rejections.

      Allowed Usage

      • Check eligibility for product tagging
      • Get catalogs and products
      • Tag media with product tags
      • Manage existing product tags
      • Appeal product rejections

    • INSTAGRAM_CONTENT_PUBLISH

      @GraphAPI(since="2.5") public static final FacebookPermissions 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.

    • INSTAGRAM_BRANDED_CONTENT_ADS_BRAND

      public static final FacebookPermissions INSTAGRAM_BRANDED_CONTENT_ADS_BRAND
      The instagram_branded_content_ads_brand permission allows an app to read Instagram posts where the app user's Instagram account is tagged as a paid partner, and an app user to read, request, and revoke permissions to run Partnership Ads.

      Allowed Usage

      • Read Instagram posts where the account is tagged as a paid partner
      • Manage permissions to run Partnership Ads without needing a pre-existing post

    • INSTAGRAM_BRANDED_CONTENT_BRAND

      public static final FacebookPermissions INSTAGRAM_BRANDED_CONTENT_BRAND
      The instagram_branded_content_brand permission allows your app to add, remove and view creators from a specific brand’s approved creators list. The allowed usage for this permission is to manage a specific brand’s Instagram creator content settings. You may also use this permission to request analytics insights to improve your app and for marketing or advertising purposes, through the use of aggregated and de-identified or anonymized information (provided such data cannot be re-identified).

      Allowed Usage

      • Manage branded creator content settings on a business’ Instagram account.

    • INSTAGRAM_BRANDED_CONTENT_CREATOR

      public static final FacebookPermissions INSTAGRAM_BRANDED_CONTENT_CREATOR
      The instagram_branded_content_creator permission allows your app to read and change the boost status of a creator’s specific piece of content. The allowed usage for this permission is to manage Instagram creator content settings. You may also use this permission to request analytics insights to improve your app and for marketing or advertising purposes, through the use of aggregated and de-identified or anonymized information (provided such data cannot be re-identified).

      Allowed Usage

      • Read and change an Instagram creator’s content settings.

    • INSTAGRAM_GRAPH_USER_MEDIA

      public static final FacebookPermissions INSTAGRAM_GRAPH_USER_MEDIA
      The instagram_graph_user_media permission allows your app to read the Media node, which represents an image, video, or album and the node’s edges.

      Review

      If your app requests this permission Facebook will have to review how your app uses it.

    • INSTAGRAM_GRAPH_USER_PROFILE

      public static final FacebookPermissions INSTAGRAM_GRAPH_USER_PROFILE
      The instagram_graph_user_profile permission allows your app to read the app user's profile.

      Review

      If your app requests this permission Facebook will have to review how your app uses it.

    • INSTAGRAM_BUSINESS_BASIC

      public static final FacebookPermissions INSTAGRAM_BUSINESS_BASIC

    • INSTAGRAM_BUSINESS_MANAGE_COMMENTS

      public static final FacebookPermissions INSTAGRAM_BUSINESS_MANAGE_COMMENTS

    • INSTAGRAM_BUSINESS_CONTENT_PUBLISH

      public static final FacebookPermissions INSTAGRAM_BUSINESS_CONTENT_PUBLISH

    • INSTAGRAM_BUSINESS_MANAGE_MESSAGES

      public static final FacebookPermissions INSTAGRAM_BUSINESS_MANAGE_MESSAGES

    • USER_MEDIA

      public static final FacebookPermissions USER_MEDIA
      The user_media permission allows your app to read the Media node, which represents an image, video, or album and the node’s edges using the Instagram Basic Display API.

      Review

      If your app requests this permission Facebook will have to review how your app uses it.

    • USER_PROFILE

      public static final FacebookPermissions USER_PROFILE
      The user_profile permission allows your app to read the app user's profile using the Instagram Basic Display API.

      Review

      If your app requests this permission Facebook will have to review how your app uses it.

    • WHATSAPP_BUSINESS_MANAGEMENT

      public static final FacebookPermissions 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.

    • WHATSAPP_BUSINESS_MESSAGING

      public static final FacebookPermissions WHATSAPP_BUSINESS_MESSAGING
      The `whatsapp_business_messaging` permission allows an app to send WhatsApp messages to a specific phone number, upload and retrieve media from messages, manage and get WhatsApp business profile information, and to register those phone numbers with Meta.

      Please see Whatsapps's reference for details.

      Review

      If your app requests this permission Facebook will have to review how your app uses it.

    • THREADS_BASIC

      public static final FacebookPermissions THREADS_BASIC
      Required for making any calls to all Threads API endpoints

      Review

      If your app requests this permission Facebook will have to review how your app uses it.

    • THREADS_CONTENT_PUBLISH

      public static final FacebookPermissions THREADS_CONTENT_PUBLISH
      Required for Threads publishing endpoints only

      Review

      If your app requests this permission Facebook will have to review how your app uses it.

    • THREADS_MANAGE_INSIGHTS

      public static final FacebookPermissions THREADS_MANAGE_INSIGHTS
      Required for making GET calls to insights endpoints

      Review

      If your app requests this permission Facebook will have to review how your app uses it.

    • THREADS_MANAGE_REPLIES

      public static final FacebookPermissions THREADS_MANAGE_REPLIES
      Required for making POST calls to reply endpoints

      Review

      If your app requests this permission Facebook will have to review how your app uses it.

    • THREADS_READ_REPLIES

      public static final FacebookPermissions THREADS_READ_REPLIES
      Required for making GET calls to reply endpoints

      Review

      If your app requests this permission Facebook will have to review how your app uses it.

    • COMMERCE_ACCOUNT_MANAGE_ORDERS

      public static final FacebookPermissions COMMERCE_ACCOUNT_MANAGE_ORDERS
      The commerce_account manage_orders permission allows your app to read and update commerce account orders.

      Allowed Usage

      • Read orders in your commerce account.
      • Tech providers manage orders on behalf of their customers.
      • Access to Webhook notifications.

    • COMMERCE_ACCOUNT_READ_ORDERS

      public static final FacebookPermissions COMMERCE_ACCOUNT_READ_ORDERS
      The commerce_account_read_orders permission allows your app to read commerce account orders.

      Allowed Usage

      • Read orders in your commerce account.
      • Use the buyer's email address for marketing purposes only if a buyer has opted-in at checkout.

    • COMMERCE_ACCOUNT_READ_REPORTS

      public static final FacebookPermissions COMMERCE_ACCOUNT_READ_REPORTS
      The commerce_account_read_reports permission allows your app to read finance reporting data to build custom tax, cash reconciliation and reimbursement reports for a commerce account.

      Allowed Usage

      • Read finance reporting data in your commerce account for building custom tax cash reconciliation and reimbursement reports.
      • Tech providers can run finance reports on behalf of their customers.

    • COMMERCE_ACCOUNT_READ_SETTINGS

      public static final FacebookPermissions COMMERCE_ACCOUNT_READ_SETTINGS
      The commerce_account_read_settings permission allows your app to read commerce account settings. Allowed Usage
      • Read basic commerce account information like connected channels, shipping options, fulfillment locations, etc.

    • COMMERCE_MANAGE_ACCOUNTS

      public static final FacebookPermissions COMMERCE_MANAGE_ACCOUNTS
      The commerce_manage_accounts permission allows your app to create and manage commerce accounts, such as an ecommerce app

      Allowed Usage

      • Associate your app with your commerce account.
      • Tech providers create a commerce account on behalf of their customers.
      • Tech providers enable a new sales channel within their customer’s commerce account.

  • Method Details

    • values

      public static FacebookPermissions[] 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

      public static FacebookPermissions valueOf(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:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null

    • getPermissionString

      public String getPermissionString()

    • getCategory

      public FacebookPermissions.Category getCategory()