Share via


Shell.Net.js

 

Applies To: Windows Azure Pack

Provides methods that can be used with jQuery to submit GET or POST requests.

Widgets

None.

Enums

None.

Properties

None.

Methods

Name

Description

Returns

Parameters

Shell.Net.addGlobalBeforeSend

Adds a global function. Used to perform customization before the ajax request is sent.

Nothing.

Function: The global function.

Shell.Net.ajax

Wraps jQuery's AJAX function of the same name to provide standard headers, logging and error handling. Perform an asynchronous HTTP (Ajax) request.

Object

url (String): A string containing the URL to which the request is sent.

options (Object): A set of key/value pairs that configure the Ajax request. All settings are optional.

A default can be set for any option with $.ajaxSetup(). For a complete list of all settings, see jQuery.ajax( settings ).

Shell.Net.ajaxPost

Wraps jQuery's AJAX function and uses POST + JSON semantics and performs a JSON.stringify on the data that's passed on. Perform an asynchronous HTTP (Ajax) request. Note: All requests to the server that return JSON (which is nearly all of them) need to use POST semantics for security reasons. By introducting this method, I am providing a way to gradually switch extensions over without breaking everything. Once everything is switched over, we may choose to deprecate the 'ajax' method below that allows the caller to specify many of the semantics.

Nothing

url (String): A string containing the URL to which the request is sent.

options (Object): A set of key/value pairs that configure the Ajax request. All settings are optional.

A default can be set for any option with $.ajaxSetup(). For a complete list of all settings, see jQuery.ajax( settings ).

Shell.Net.get

Load data from the server using a HTTP GET request. Wraps jQuery's AJAX function of the same name to provide standard headers, logging and error handling.

Object

url (String): A string containing the URL to which the request is sent.

data (String): A map or string that is sent to the server with the request.

callback (Function): A callback function that is executed if the request succeeds.

type (String): The type of data expected from the server. Default: Intelligent Guess (xml, json, script, or html).

Shell.Net.getJSON

Load JSON-encoded data from the server using a GET HTTP request. Wraps jQuery's AJAX function of the same name to provide standard headers, logging and error handling.

Object

url (String): A string containing the URL to which the request is sent.

data (Object): A map or string that is sent to the server with the request.

callback (Function): A callback function that is executed if the request succeeds.

Shell.Net.post

Load data from the server using a HTTP POST request. . Wraps jQuery's AJAX function of the same name to provide standard headers, logging and error handling.

Nothing

url (String): A string containing the URL to which the request is sent.

data (String): A map or string that is sent to the server with the request.

callback (Function): A callback function that is executed if the request succeeds.

type (String): The type of data expected from the server. Default: Intelligent Guess (xml, json, script, or html).

Shell.Net.removeGlobalBeforeSend

Removes a global function.

Func: The global function to remove.

See Also

Windows Azure Pack Extension Shell Library Reference