MindTouch JavaScript API

Reload(dom ,params, callback)

dom : (*)

MISSING

params : object

MISSING

callback : (*)

MISSING

CreatePageProperty(page_api, name, value, success, error)

page_api : string

MISSING

name : string

Fully qualified property name with namespace prefix.

value : (*)

New property value to store.  

(string) The string value is stored as text/plain.

(object) The object value is converted to a JSON string and stored as application/json.

success : (*)

Callback when operation is successful.  The callback takes one result object argument: { etag: property_etag, xhr: xml_http_request_object }.

(function) Function to invoke with the result object.

(string) Name of the channel on which to publish the result object.

error : (*)

Callback when operation encounters an error.  The callback takes one result object argument: { status: http_status_code, text: http_status_message, xhr: xml_http_request_object }.

(function) Function to invoke with the result object.

(string) Name of the channel on which to publish the result object.

ReadPageProperty(page_api, name, success, error)

CreateProperty(properties_api, name, value, success, error)

properties_api : string

MISSING

name : string

Fully qualified property name with namespace prefix.

value : (*)

New property value to store.  

(string) The string value is stored as text/plain.

(object) The object value is converted to a JSON string and stored as application/json.

success : (*)

Callback when operation is successful.  The callback takes one result object argument: { etag: property_etag, xhr: xml_http_request_object }.

(function) Function to invoke with the result object.

(string) Name of the channel on which to publish the result object.

error : (*)

Callback when operation encounters an error.  The callback takes one result object argument: { status: http_status_code, text: http_status_message, xhr: xml_http_request_object }.

(function) Function to invoke with the result object.

(string) Name of the channel on which to publish the result object.

ReadProperty(properties_api, name, success, error)

name : string

Fully qualified property name with namespace prefix.

success : (*)

Callback when operation is successful.  The callback takes one result object argument: { value: property_value, href: property_href, etag: property_etag, xhr: xml_http_request_object }.

(function) Function to invoke with the result object.

(string) Name of the channel on which to publish the result object.

error : (*)

Callback when operation encounters an error.  The callback takes one result object argument: { status: http_status_code, text: http_status_message, xhr: xml_http_request_object }.

(function) Function to invoke with the result object.

(string) Name of the channel on which to publish the result object.

UpdateProperty(property_api, value, etag, success, error)

name : string

Fully qualified property name with namespace prefix.

value : (*)

New property value to store.  

(string) The string value is stored as text/plain.

(object) The object value is converted to a JSON string and stored as application/json.

success : (*)

Callback when operation is successful.  The callback takes one result object argument: { etag: property_etag, xhr: xml_http_request_object }.

(function) Function to invoke with the result object.

(string) Name of the channel on which to publish the result object.

error : (*)

Callback when operation encounters an error.  The callback takes one result object argument: { status: http_status_code, text: http_status_message, xhr: xml_http_request_object }.

(function) Function to invoke with the result object.

(string) Name of the channel on which to publish the result object.

DeleteProperty(property_api, success, error)

property_api : string

MISSING

success : (*)

Callback when operation is successful.  The callback takes one result object argument: { xhr: xml_http_request_object }.

(function) Function to invoke with the result object.

(string) Name of the channel on which to publish the result object.

error : (*)

Callback when operation encounters an error.  The callback takes one result object argument: { status: http_status_code, text: http_status_message, xhr: xml_http_request_object }.

(function) Function to invoke with the result object.

(string) Name of the channel on which to publish the result object.

Get(uri, headers, callback)

MISSING

Post(uri, value, mimetype, headers, callback)

MISSING

Put(uri, value, mimetype, headers, callback)

MISSING

Delete(uri, headers, callback)

MISSING