[SHINDIG-1065] osapi (oslite) should support user mediated requests.

• Type: New Feature
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Fix Version/s: 1.1-BETA1
• Component/s: Javascript
• Assignee: Louis Ryan
• Reporter: Sachin Shenoy
• Created: 19/May/09 19:36
• Updated: 23/Jul/09 21:28
• Resolved: 23/Jul/09 21:26

Description

According to osapi spec any request can be user mediated. (there is no more osapi.ui.*). Shindig to support mechanism for user mediated requests.

Changes:

• Containers can via configuration let shindig JS know which requests it want to be user mediated.
• Predefined hooks are used to pass the request to the container and get the response back.
• A new type of request, osapi.newUiRequest is defined to handle user mediated case. Even though this is in global space, it need not be visible to the developer directly. Developer uses the osapi as today.
• batch.js is modified to allow handling of user mediated requests.
• So that developer can know which request may get user mediated, every request exposes a boolean field userMediated (this is not part of standard but could be good to have something like this for future version). This would allow developers to write code like below,

var r = osapi.activites.create();
if (r.userMediated) {
// skip creating activity, as I don't want to bug the user.
} else {
r.execute();
}