Fb:multi-friend-selector
From Facebook Developer Wiki
Contents |
Description
Facebook is modifying the way you can use the multi-friend selectors. Details will follow soon.
For more information, please read the Developer Roadmap, specifically, the sections on requests and invites.
There are actually two versions of this button - the full version and the condensed version. This page describes the full version. For information about the condensed version, see fb:multi-friend-selector (condensed).
This is a nearly full-page interface intended to be used on canvas pages to allow the user to send a "large" number of requests or invitations (where "large" is generally some number more than 4). This tag must be used inside an fb:request-form tag. This interface includes a series of <input type="hidden" name="ids[]" value="[friend id]"> which are included for selected users in the form that gets submitted to your <fb:request-form> action URL. Both the Skip this Step button and the Submit button take the user to the parent fb:request-form action URL.
Your users can invite their friends who aren't yet on Facebook by entering their email addresses in the text box at the bottom of the multi-friend selector. You need to use Express Registration in order to have those friends join Facebook and authorize your application at the same time. After the friend authorizes your application, it gets bookmarked automatically.
For developers using iframes, a full page version of this is available. Please see Multi_friend_selector for information about using it.
As a best practice suggestion, please choose the appropriate bypass string for the context in which the multi-friend selector appears. For example, if the user clicks a link to explicitly arrive at the multi-friend selector, "Cancel" may be the appropriate string. However, if the user arrives at the multi-friend selector within the context of an application flow, the default "Skip" is more appropriate, as "Cancel" may imply the cancellation of the application flow instead.
A user may invite a number of people each day equal to the maximum number of requests allocated to your application. If a user attempts to go over this limit, the following message appears:
Attributes
| Required | Name | Type | Description | |
| required | actiontext | string | An instructional message to display to users at the top of the multi-friend-selector. | |
|---|---|---|---|---|
| optional | showborder | bool | Indicates whether you want a border around the outside of the multi-friend-selector. | |
| rows | int | The number of rows of friends to show in the multi-friend-selector. (Default value is 5 and the value must be between 3 and 10.) | ||
| max | int | The maximum number of users that can be selected. This value ranges from 1 to 35, and is capped at the number of friend requests the user has remaining under their limit. This attribute is ignored if it is greater than the number of requests your application is able to send. | ||
| exclude_ids | array | A comma-separated list of user IDs to exclude from the multi-friend-selector. | ||
| bypass | string | The version of the Bypass button you want to use. Set this attribute to "step", "cancel", or "skip", which results in Skip This Step, Cancel, or Skip, respectively. (Default value is skip.) | ||
| email_invite | bool | Indicates whether you want to display an email invite section in the multi-friend-selector. | ||
| cols | int | The number of columns of friends to show in the multi-friend selector, which also determines the width of the invite box. The value must be one of: 2 (which sets the box to 368px wide), 3 (which sets it to 466px wide), or 5 (which sets it to 740px wide). (Default value is 5.) |
POST Variables
| Required | Name | Type | Description | |
| ids | array | An array of the user IDs chosen by the user. |
Examples
 |
