rb:request-form

Description

Creates a form that sends requests to the selected users. To send requests/invitations to users, create one of these forms and include either an rb:multi-friend-selector or any combination of rb:multi-friend-input, rb:friend-selector and rb:request-form-submit. The form is submitted after the user confirms the sending of the request.

In the case where you are not using an rb:multi-friend-selector, the only way for a user to submit a request/invitation through this form is via an rb:request-form-submit button.

In general, use rb:multi-friend-selector in a nearly full-page invitation interface where the user is intended to select a large number of people, and rb:friend-selector or rb:multi-friend-input in situations where the user is selecting a smaller number of users and you want to integrate it into the context of your own page. As a middle-ground alternative, you can use the rb:multi-friend-selector (condensed) for places where the user might select a medium-sized list of people without needing a full-page interstitial invitations interface.

For developers using iframes, you cannot get the full flexibility of the rb:request-form system. However, you can still send requests using the Multi_friend_selector, or you can use the rb_force_mode parameter to render a particular canvas page with RBML.


Attributes

required type string The type of request or invitation to generate. This corresponds to the word that is displayed on the home page. For example, "event."
content string The contents of the request or invitation to be sent. It should use RBML formatting that contains only links and the special tag <rb:req-choice url="" label="" /> to specify the buttons to be included in the request. Make sure that you properly encode this attribute. For example, use the PHP "htmlentities" function.
optional invite bool Set this to true if you want to send an invitation or false if you want to send a request. The difference between them is in the content that the user sees. (default value is false)
action string The place where a user gets redirected after submitting the form through the rb:request-form-submit button or when they click Skip this Step. By default the user is directed to Sociali.com/yourapp/null. Note: This default behavior may not be preserved.
method string Set it to either GET or POST, as you would with a form.

 

POST Variables

typeahead string The string containing any content the user typed into the multi-selector box.
ids array A zero-based array containing all of the user IDs of the people the user invited.

 

 

Notes

  • Make sure to include whatever attributes you would normally include if you were creating a <form> tag, such as action and method, as mentioned above.