Version: 0.5, Last updated: 9/11/2009
|jQuery postMessage: Cross-domain scripting goodness||Version: 0.5, Last updated: 9/11/2009|
|License||Copyright © 2009 “Cowboy” Ben Alman, Dual licensed under the MIT and GPL licenses.|
|Examples||This working example, complete with fully commented code, illustrates one way in which this plugin can be used.|
|Support and Testing||Information about what version or versions of jQuery this plugin has been tested with and what browsers it has been tested in.|
|jQuery.||This method will call window.postMessage if available, setting the targetOrigin parameter to the base of the target_url parameter for maximum security in browsers that support it.|
|jQuery.||Register a single callback for either a window.postMessage call, if supported, or if unsupported, for any change in the current window location.hash.|
Copyright © 2009 “Cowboy” Ben Alman, Dual licensed under the MIT and GPL licenses. http://benalman.com/about/license/
This working example, complete with fully commented code, illustrates one way in which this plugin can be used.
This method will call window.postMessage if available, setting the targetOrigin parameter to the base of the target_url parameter for maximum security in browsers that support it. If window.postMessage is not available, the target window’s location.hash will be used to pass the message. If an object is passed as the message param, it will be serialized into a string using the jQuery.param method.
jQuery.postMessage( message, target_url [, target ] );
|message||(String) A message to be passed to the other frame.|
|message||(Object) An object to be serialized into a params string, using the jQuery.param method.|
|target_url||(String) The URL of the other frame this window is attempting to communicate with. This must be the exact URL (including any query string) of the other window for this script to work in browsers that don’t support window.postMessage.|
|target||(Object) A reference to the other frame this window is attempting to communicate with. If omitted, defaults to `parent`.|
Register a single callback for either a window.postMessage call, if supported, or if unsupported, for any change in the current window location.hash. If window.postMessage is supported and source_origin is specified, the source window will be checked against this for maximum security. If window.postMessage is unsupported, a polling loop will be started to watch for changes to the location.hash.
Note that for simplicity’s sake, only a single callback can be registered at one time. Passing no params will unbind this event (or stop the polling loop), and calling this method a second time with another callback will unbind the event (or stop the polling loop) first, before binding the new callback.
Also note that if window.postMessage is available, the optional source_origin param will be used to test the event.origin property. From the MDC window.postMessage docs: This string is the concatenation of the protocol and “://”, the host name if one exists, and “:” followed by a port number if a port is present and differs from the default port for the given protocol. Examples of typical origins are https://example.org (implying port 443), http://example.net (implying port 80), and http://example.com:8080.
jQuery.receiveMessage( callback [, source_origin ] [, delay ] );
|callback||(Function) This callback will execute whenever a jQuery.postMessage message is received, provided the source_origin matches. If callback is omitted, any existing receiveMessage event bind or polling loop will be canceled.|
|source_origin||(String) If window.postMessage is available and this value is not equal to the event.origin property, the callback will not be called.|
|source_origin||(Function) If window.postMessage is available and this function returns false when passed the event.origin property, the callback will not be called.|
|delay||(Number) An optional zero-or-greater delay in milliseconds at which the polling loop will execute (for browser that don’t support window.postMessage). If omitted, defaults to 100.|