com.vaadin.polymer.iron.element.IronRequestElement Maven / Gradle / Ivy
/*
* This code was generated with Vaadin Web Component GWT API Generator,
* from iron-ajax project by The Polymer Authors
* that is licensed with http://polymer.github.io/LICENSE.txt license.
*/
package com.vaadin.polymer.iron.element;
import com.vaadin.polymer.elemental.*;
import com.google.gwt.core.client.JavaScriptObject;
import com.google.gwt.core.client.JsArray;
import com.google.gwt.core.client.js.JsProperty;
import com.google.gwt.core.client.js.JsType;
/**
* iron-request can be used to perform XMLHttpRequests.
* <iron-request id="xhr"></iron-request>
* ...
* this.$.xhr.send({url: url, params: params});
*
*
*/
@JsType
public interface IronRequestElement extends HTMLElement {
public static final String TAG = "iron-request";
public static final String SRC = "iron-ajax/iron-ajax.html";
/**
* Aborts the request.
*
* JavaScript Info:
* @method abort
*
*/
void abort();
/**
* Aborted will be true if an abort of the request is attempted.
*
* JavaScript Info:
* @property aborted
* @type Boolean
*
*/
@JsProperty boolean getAborted();
/**
* Aborted will be true if an abort of the request is attempted.
*
* JavaScript Info:
* @property aborted
* @type Boolean
*
*/
@JsProperty void setAborted(boolean value);
/**
* A promise that resolves when the xhr response comes back, or rejects
if there is an error before the xhr completes.
*
* JavaScript Info:
* @property completes
* @type Object
*
*/
@JsProperty JavaScriptObject getCompletes();
/**
* A promise that resolves when the xhr response comes back, or rejects
if there is an error before the xhr completes.
*
* JavaScript Info:
* @property completes
* @type Object
*
*/
@JsProperty void setCompletes(JavaScriptObject value);
/**
* Attempts to parse the response body of the XHR. If parsing succeeds,
the value returned will be deserialized based on the responseType
set on the XHR.
*
* JavaScript Info:
* @method parseResponse
*
*/
void parseResponse();
/**
* An object that contains progress information emitted by the XHR if
available.
*
* JavaScript Info:
* @property progress
* @type Object
*
*/
@JsProperty JavaScriptObject getProgress();
/**
* An object that contains progress information emitted by the XHR if
available.
*
* JavaScript Info:
* @property progress
* @type Object
*
*/
@JsProperty void setProgress(JavaScriptObject value);
/**
* A reference to the parsed response body, if the xhr has completely
resolved.
*
* JavaScript Info:
* @property response
* @type *
*
*/
@JsProperty JavaScriptObject getResponse();
/**
* A reference to the parsed response body, if the xhr has completely
resolved.
*
* JavaScript Info:
* @property response
* @type *
*
*/
@JsProperty void setResponse(JavaScriptObject value);
/**
* Sends an HTTP request to the server and returns the XHR object.
*
* JavaScript Info:
* @method send
* @param {{url: string, method: (string|undefined), async: (boolean|undefined), body: (ArrayBuffer|ArrayBufferView|Blob|Document|FormData|null|string|undefined), headers: (Object|undefined), handleAs: (string|undefined), withCredentials: (boolean|undefined)}} options
*
*/
void send(JavaScriptObject options);
/**
* Succeeded is true if the request succeeded. The request succeeded if the
status code is greater-than-or-equal-to 200, and less-than 300. Also,
the status code 0 is accepted as a success even though the outcome may
be ambiguous.
*
* JavaScript Info:
* @method succeeded
*
*/
void succeeded();
/**
* A reference to the XMLHttpRequest instance used to generate the
network request.
*
* JavaScript Info:
* @property xhr
* @type Object
*
*/
@JsProperty JavaScriptObject getXhr();
/**
* A reference to the XMLHttpRequest instance used to generate the
network request.
*
* JavaScript Info:
* @property xhr
* @type Object
*
*/
@JsProperty void setXhr(JavaScriptObject value);
}