Enum FacebookPermissions

    • Enum Constant Detail

      • 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_ABOUT_ME

        @Deprecated
        public static final FacebookPermissions USER_ABOUT_ME
        Deprecated.
        since breaking change on 4 April, 2018
        Provides 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
        public static final FacebookPermissions USER_ACTIONS_BOOKS
        Deprecated.
        since breaking change on 4 April, 2018
        Provides 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
        public static final FacebookPermissions USER_ACTIONS_FITNESS
        Deprecated.
        since breaking change on 4 April, 2018
        Provides 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
        public static final FacebookPermissions USER_ACTIONS_MUSIC
        Deprecated.
        since breaking change on 4 April, 2018
        Provides 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
        public static final FacebookPermissions USER_ACTIONS_NEWS
        Deprecated.
        since breaking change on 4 April, 2018
        Provides 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
        public static final FacebookPermissions USER_ACTIONS_VIDEO
        Deprecated.
        since breaking change on 4 April, 2018
        Provides 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_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_EDUCATION_HISTORY

        @Deprecated
        public static final FacebookPermissions USER_EDUCATION_HISTORY
        Deprecated.
        since breaking change on 4 April, 2018
        Provides 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

        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_GAMES_ACTIVITY

        @Deprecated
        public static final FacebookPermissions USER_GAMES_ACTIVITY
        Deprecated.
        since breaking change on 4 April, 2018
        Provides 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

        @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_LINK

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

        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_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_RELATIONSHIP_DETAILS

        @Deprecated
        public static final FacebookPermissions USER_RELATIONSHIP_DETAILS
        Deprecated.
        since breaking change on 4 April, 2018
        Provides access to a person's relationship interests as the interested_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
        public static final FacebookPermissions USER_RELATIONSHIPS
        Deprecated.
        since breaking change on 4 April, 2018
        Provides 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
        public static final FacebookPermissions USER_RELIGION_POLITICS
        Deprecated.
        since breaking change on 4 April, 2018
        Provides 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

        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.

      • USER_WEBSITE

        @Deprecated
        public static final FacebookPermissions USER_WEBSITE
        Deprecated.
        since breaking change on 4 April, 2018
        Provides 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
        public static final FacebookPermissions USER_WORK_HISTORY
        Deprecated.
        since breaking change on 4 April, 2018
        Provides access to a person's work history and list of employers via the work field on the User object.

        Review

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

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

      • MANAGE_PAGES

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

      • PUBLISH_ACTIONS

        @Deprecated
        public static final FacebookPermissions PUBLISH_ACTIONS
        Deprecated.
        this permission is deprecated and it is not possible to publish anything to the user feed via Graph API since April 2018
        Provides 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

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

      • PUBLISH_TO_GROUPS

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

        @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")
        public static final FacebookPermissions 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_FRIENDLISTS

        @Deprecated
        @GraphAPI(until="2.2")
        public static final FacebookPermissions READ_FRIENDLISTS
        Deprecated.
        not usable since Graph API 2.3, use READ_CUSTOM_FRIENDLISTS instead. If you use the Graph API before 2.3 ignore the deprecation warning
        Provides 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
        @GraphAPI(since="2.3")
        public static final FacebookPermissions READ_CUSTOM_FRIENDLISTS
        Deprecated.
        since breaking change on 4 April, 2018
        Provides 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

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

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

        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.

      • 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_SUBSCRPTIONS

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

    • Method Detail

      • values

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