com.google.appinventor.components.runtime

Class Web

java.lang.Object

com.google.appinventor.components.runtime.AndroidNonvisibleComponent

com.google.appinventor.components.runtime.Web

All Implemented Interfaces:

Component

public class Web
extends AndroidNonvisibleComponent
implements Component

The Original Web component provided functions for HTTP GET and POST requests. This new version provides added PUT and DELETE requests.

Field Summary

Fields inherited from class com.google.appinventor.components.runtime.AndroidNonvisibleComponent

form

Fields inherited from interface com.google.appinventor.components.runtime.Component

ACCELEROMETER_SENSITIVITY_MODERATE, ACCELEROMETER_SENSITIVITY_STRONG, ACCELEROMETER_SENSITIVITY_WEAK, ALIGNMENT_CENTER, ALIGNMENT_NORMAL, ALIGNMENT_OPPOSITE, ASSET_DIRECTORY, BUTTON_SHAPE_DEFAULT, BUTTON_SHAPE_OVAL, BUTTON_SHAPE_RECT, BUTTON_SHAPE_ROUNDED, COLOR_BLACK, COLOR_BLUE, COLOR_CYAN, COLOR_DEFAULT, COLOR_DKGRAY, COLOR_GRAY, COLOR_GREEN, COLOR_LTGRAY, COLOR_MAGENTA, COLOR_NONE, COLOR_ORANGE, COLOR_PINK, COLOR_RED, COLOR_WHITE, COLOR_YELLOW, DEFAULT_VALUE_COLOR_BLACK, DEFAULT_VALUE_COLOR_BLUE, DEFAULT_VALUE_COLOR_CYAN, DEFAULT_VALUE_COLOR_DEFAULT, DEFAULT_VALUE_COLOR_DKGRAY, DEFAULT_VALUE_COLOR_GRAY, DEFAULT_VALUE_COLOR_GREEN, DEFAULT_VALUE_COLOR_LTGRAY, DEFAULT_VALUE_COLOR_MAGENTA, DEFAULT_VALUE_COLOR_NONE, DEFAULT_VALUE_COLOR_ORANGE, DEFAULT_VALUE_COLOR_PINK, DEFAULT_VALUE_COLOR_RED, DEFAULT_VALUE_COLOR_WHITE, DEFAULT_VALUE_COLOR_YELLOW, DIRECTION_EAST, DIRECTION_MAX, DIRECTION_MIN, DIRECTION_NONE, DIRECTION_NORTH, DIRECTION_NORTHEAST, DIRECTION_NORTHWEST, DIRECTION_SOUTH, DIRECTION_SOUTHEAST, DIRECTION_SOUTHWEST, DIRECTION_WEST, FONT_DEFAULT_SIZE, LAYOUT_ORIENTATION_HORIZONTAL, LAYOUT_ORIENTATION_VERTICAL, LENGTH_FILL_PARENT, LENGTH_PREFERRED, LENGTH_UNKNOWN, SLIDER_MAX_VALUE, SLIDER_MIN_VALUE, SLIDER_THUMB_VALUE, TOAST_LENGTH_LONG, TOAST_LENGTH_SHORT, TYPEFACE_DEFAULT, TYPEFACE_MONOSPACE, TYPEFACE_SANSSERIF, TYPEFACE_SERIF

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Web() This constructor is for testing purposes only.
	Web(ComponentContainer container) Creates a new Web component.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	AllowCookies() Returns whether cookies should be allowed
void	AllowCookies(boolean allowCookies) Specifies whether cookies should be allowed
java.lang.String	BuildRequestData(YailList list) Converts a list of two-element sublists, representing name and value pairs, to a string formatted as application/x-www-form-urlencoded media type, suitable to pass to PostText.
void	ClearCookies()
void	Delete() Performs an HTTP DELETE request using the Url property and retrieves the response. If the SaveResponse property is true, the response will be saved in a file and the GotFile event will be triggered.
void	Get() Performs an HTTP GET request using the Url property and retrieves the response. If the SaveResponse property is true, the response will be saved in a file and the GotFile event will be triggered.
void	GotFile(java.lang.String url, int responseCode, java.lang.String responseType, java.lang.String fileName) Event indicating that a request has finished.
void	GotText(java.lang.String url, int responseCode, java.lang.String responseType, java.lang.String responseContent) Event indicating that a request has finished.
java.lang.String	HtmlTextDecode(java.lang.String htmlText) Decodes the given HTML text value.
java.lang.Object	JsonTextDecode(java.lang.String jsonText) Decodes the given JSON encoded value to produce a corresponding AppInventor value.
void	PostFile(java.lang.String path) Performs an HTTP POST request using the Url property and data from the specified file, and retrieves the response.
void	PostText(java.lang.String text) Performs an HTTP POST request using the Url property and the specified text.
void	PostTextWithEncoding(java.lang.String text, java.lang.String encoding) Performs an HTTP POST request using the Url property and the specified text.
void	PutFile(java.lang.String path) Performs an HTTP PUT request using the Url property and data from the specified file, and retrieves the response.
void	PutText(java.lang.String text) Performs an HTTP PUT request using the Url property and the specified text.
void	PutTextWithEncoding(java.lang.String text, java.lang.String encoding) Performs an HTTP PUT request using the Url property and the specified text.
YailList	RequestHeaders() Returns the request headers.
void	RequestHeaders(YailList list) Sets the request headers.
java.lang.String	ResponseFileName() Returns the name of the file where the response should be saved.
void	ResponseFileName(java.lang.String responseFileName) Specifies the name of the file where the response should be saved.
boolean	SaveResponse() Returns whether the response should be saved in a file.
void	SaveResponse(boolean saveResponse) Specifies whether the response should be saved in a file.
java.lang.String	UriEncode(java.lang.String text) Encodes the given text value so that it can be used in a URL.
java.lang.String	Url() Returns the URL.
void	Url(java.lang.String url) Specifies the URL.
java.lang.Object	XMLTextDecode(java.lang.String XmlText) Decodes the given XML string to produce a list structure.

Methods inherited from class com.google.appinventor.components.runtime.AndroidNonvisibleComponent

getDispatchDelegate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.google.appinventor.components.runtime.Component

getDispatchDelegate

Constructor Detail

Web

public Web(ComponentContainer container)

Creates a new Web component.

Parameters:

container - the Form that this component is contained in.

Web

protected Web()

This constructor is for testing purposes only.

Method Detail

Url

public java.lang.String Url()

Returns the URL.

Url

public void Url(java.lang.String url)

Specifies the URL.

RequestHeaders

public YailList RequestHeaders()

Returns the request headers.

RequestHeaders

public void RequestHeaders(YailList list)

Sets the request headers.

Parameters:

list - a list of two-element sublists, each representing a header name and values

AllowCookies

public boolean AllowCookies()

Returns whether cookies should be allowed

AllowCookies

public void AllowCookies(boolean allowCookies)

Specifies whether cookies should be allowed

SaveResponse

public boolean SaveResponse()

Returns whether the response should be saved in a file.

SaveResponse

public void SaveResponse(boolean saveResponse)

Specifies whether the response should be saved in a file.

ResponseFileName

public java.lang.String ResponseFileName()

Returns the name of the file where the response should be saved. If SaveResponse is true and ResponseFileName is empty, then a new file name will be generated.

ResponseFileName

public void ResponseFileName(java.lang.String responseFileName)

Specifies the name of the file where the response should be saved. If SaveResponse is true and ResponseFileName is empty, then a new file name will be generated.

ClearCookies

public void ClearCookies()

Get

public void Get()

Performs an HTTP GET request using the Url property and retrieves the response.
If the SaveResponse property is true, the response will be saved in a file and the GotFile event will be triggered. The ResponseFileName property can be used to specify the name of the file.
If the SaveResponse property is false, the GotText event will be triggered.

PostText

public void PostText(java.lang.String text)

Performs an HTTP POST request using the Url property and the specified text.

Parameters:

text - the text data for the POST request

PostTextWithEncoding

public void PostTextWithEncoding(java.lang.String text,
                        java.lang.String encoding)

Performs an HTTP POST request using the Url property and the specified text.

Parameters:

text - the text data for the POST request

encoding - the character encoding to use when sending the text. If encoding is empty or null, UTF-8 encoding will be used.

PostFile

public void PostFile(java.lang.String path)

Performs an HTTP POST request using the Url property and data from the specified file, and retrieves the response.

Parameters:

path - the path of the file for the POST request

PutText

public void PutText(java.lang.String text)

Performs an HTTP PUT request using the Url property and the specified text.

Parameters:

text - the text data for the PUT request

PutTextWithEncoding

public void PutTextWithEncoding(java.lang.String text,
                       java.lang.String encoding)

Performs an HTTP PUT request using the Url property and the specified text.

Parameters:

text - the text data for the PUT request

encoding - the character encoding to use when sending the text. If encoding is empty or null, UTF-8 encoding will be used.

PutFile

public void PutFile(java.lang.String path)

Performs an HTTP PUT request using the Url property and data from the specified file, and retrieves the response.

Parameters:

path - the path of the file for the PUT request

Delete

public void Delete()

Performs an HTTP DELETE request using the Url property and retrieves the response.
If the SaveResponse property is true, the response will be saved in a file and the GotFile event will be triggered. The ResponseFileName property can be used to specify the name of the file.
If the SaveResponse property is false, the GotText event will be triggered.

GotText

public void GotText(java.lang.String url,
           int responseCode,
           java.lang.String responseType,
           java.lang.String responseContent)

Event indicating that a request has finished.

Parameters:

url - the URL used for the request

responseCode - the response code from the server

responseType - the mime type of the response

responseContent - the response content from the server

GotFile

public void GotFile(java.lang.String url,
           int responseCode,
           java.lang.String responseType,
           java.lang.String fileName)

Event indicating that a request has finished.

Parameters:

url - the URL used for the request

responseCode - the response code from the server

responseType - the mime type of the response

fileName - the full path name of the saved file

BuildRequestData

public java.lang.String BuildRequestData(YailList list)

Converts a list of two-element sublists, representing name and value pairs, to a string formatted as application/x-www-form-urlencoded media type, suitable to pass to PostText.

Parameters:

list - a list of two-element sublists representing name and value pairs

UriEncode

public java.lang.String UriEncode(java.lang.String text)

Encodes the given text value so that it can be used in a URL.

Parameters:

text - the text to encode

Returns:

the encoded text

JsonTextDecode

public java.lang.Object JsonTextDecode(java.lang.String jsonText)

Decodes the given JSON encoded value to produce a corresponding AppInventor value. A JSON list [x, y, z] decodes to a list (x y z), A JSON object with name A and value B, (denoted as A:B enclosed in curly braces) decodes to a list ((A B)), that is, a list containing the two-element list (A B).

Parameters:

jsonText - the JSON text to decode

Returns:

the decoded text

XMLTextDecode

public java.lang.Object XMLTextDecode(java.lang.String XmlText)

Decodes the given XML string to produce a list structure. string decodes to a list that contains a pair of tag and string. More generally, if obj1, obj2, ... are tag-delimited XML strings, then obj1 obj2 ... decodes to a list that contains a pair whose first element is tag and whose second element is the list of the decoded obj's, ordered alphabetically by tags. Examples: 123 decodes to a one-item list containing the pair (foo, 123) 1 2 3 decodes to a one-item list containing the pair (foo,"1 2 3") 1 2 3456 decodes to a list containing the pair (a,X) where X is a 2-item list that contains the pair (bar,123) and the pair (foo,"1 2 3"). If the sequence of obj's mixes tag-delimited and non-tag-delimited items, then the non-tag-delimited items are pulled out of the sequence and wrapped with a "content" tag. For example, decoding 456many1 2 3apples is similar to above, except that the list X is a 3-item list that contains the additional pair whose first item is the string "content", and whose second item is the list (many, apples). This method signals an error and returns the empty list if the result is not well-formed XML.

Parameters:

jsonText - the JSON text to decode

Returns:

the decoded text

HtmlTextDecode

public java.lang.String HtmlTextDecode(java.lang.String htmlText)

Decodes the given HTML text value.

 HTML Character Entities such as &, <, >, ', and " are
 changed to &, <, >, ', and ".
 Entities such as &#xhhhh, and &#nnnn are changed to the appropriate characters.
 

Parameters:

htmlText - the HTML text to decode

Returns:

the decoded text