Bug 803765 - Documentation for aRequestPrincipal r=bz

This commit is contained in:
Devdatta Akhawe 2012-10-23 21:44:11 -07:00
parent 2e4dc8b044
commit bcf0534cfb

View File

@ -176,6 +176,8 @@ interface nsIContentPolicy : nsISupports
* @param aContext OPTIONAL. the nsIDOMNode or nsIDOMWindow that
* initiated the request, or something that can QI
* to one of those; can be null if inapplicable.
* Note that for navigation events (new windows and
* link clicks), this is the NEW window.
*
* @param aMimeTypeGuess OPTIONAL. a guess for the requested content's
* MIME type, based on information available to
@ -186,6 +188,12 @@ interface nsIContentPolicy : nsISupports
* @param aExtra an OPTIONAL argument, pass-through for non-Gecko
* callers to pass extra data to callees.
*
* @param aRequestPrincipal an OPTIONAL argument, defines the principal that
* caused the load. This is optional only for
* non-gecko code: all gecko code should set this
* argument. For navigation events, this is
* the principal of the page that caused this load.
*
* @return ACCEPT or REJECT_*
*
* @note shouldLoad can be called while the DOM and layout of the document