Detailed Description

A package of content such as binary data, text or an image.

Inheritance diagram for PowerUI.ContentPackage:

Public Member Functions
void	setRequestBody (Json.JSObject toPost)
	Sets the PostData from the given JSON object. Changes the content type too. More...

void	setRequestBody (string toPost)
	Sets the PostData from the given UTF8 string. More...

void	abort ()
	Aborts this request. More...

void	AttachForm (UnityEngine.WWWForm form)
	Adds the given form to this request. Note that if you wish to also use custom headers with a form, call this first. Then, add to the Headers property. More...

void	TimedOut ()
	The request has timed out. More...

void	NotModified (CachedContent cacheEntry)
	A 304 not modified response. More...

void	SetPartialResponse (int start, int end, int total)
	Sets the Content-Range response. More...

bool	GetRange (out int start, out int end)
	Gets the range request header. More...

void	Failed (int status)
	Goes straight to ready state 4 and the given status. More...

Public Member Functions inherited from Dom.EventTarget
void	ClearEvents ()
	Clears all events on this document. More...

bool	dispatchEvent (Event e)
	Runs an event of the given name. More...

void	addEventListener (string name, EventListener listener)
	Adds an event listener to this document. More...

void	addEventListener (string name, EventListener listener, bool useCapture)
	Adds an event listener to this document. More...

void	removeEventListener (string name, object evtHandlerInternal)
	Removes an event listener from this document. More...

void	addEventListener (string name, AnimationEventDelegate method)

void	addEventListener (string name, AudioProcessingEventDelegate method)

void	addEventListener (string name, BeforeInputEventDelegate method)

void	addEventListener (string name, BeforeUnloadEventDelegate method)

void	addEventListener (string name, BlobEventDelegate method)

void	addEventListener (string name, ClipboardEventDelegate method)

void	addEventListener (string name, CloseEventDelegate method)

void	addEventListener (string name, CompositionEventDelegate method)

void	addEventListener (string name, CustomEventDelegate method)

void	addEventListener (string name, CSSFontFaceLoadEventDelegate method)

void	addEventListener (string name, DeviceLightEventDelegate method)

void	addEventListener (string name, DeviceMotionEventDelegate method)

void	addEventListener (string name, DeviceOrientationEventDelegate method)

void	addEventListener (string name, DeviceProximityEventDelegate method)

void	addEventListener (string name, DomEventDelegate method)

void	addEventListener (string name, DOMTransactionEventDelegate method)

void	addEventListener (string name, DragEventDelegate method)

void	addEventListener (string name, EditingBeforeInputEventDelegate method)

void	addEventListener (string name, ErrorEventDelegate method)

void	addEventListener (string name, FetchEventDelegate method)

void	addEventListener (string name, FocusEventDelegate method)

void	addEventListener (string name, GamepadEventDelegate method)

void	addEventListener (string name, HashChangeEventDelegate method)

void	addEventListener (string name, IDBVersionChangeEventDelegate method)

void	addEventListener (string name, InputEventDelegate method)

void	addEventListener (string name, KeyboardEventDelegate method)

void	addEventListener (string name, MediaStreamEventDelegate method)

void	addEventListener (string name, MessageEventDelegate method)

void	addEventListener (string name, MouseEventDelegate method)

void	addEventListener (string name, MutationEventDelegate method)

void	addEventListener (string name, OfflineAudioCompletionEventDelegate method)

void	addEventListener (string name, PageTransitionEventDelegate method)

void	addEventListener (string name, PointerEventDelegate method)

void	addEventListener (string name, PopStateEventDelegate method)

void	addEventListener (string name, ProgressEventDelegate method)

void	addEventListener (string name, RelatedEventDelegate method)

void	addEventListener (string name, RTCDataChannelEventDelegate method)

void	addEventListener (string name, RTCIdentityErrorEventDelegate method)

void	addEventListener (string name, RTCIdentityEventDelegate method)

void	addEventListener (string name, RTCPeerConnectionIceEventDelegate method)

void	addEventListener (string name, SensorEventDelegate method)

void	addEventListener (string name, StorageEventDelegate method)

void	addEventListener (string name, TextEventDelegate method)

void	addEventListener (string name, TimeEventDelegate method)

void	addEventListener (string name, TouchEventDelegate method)

void	addEventListener (string name, TrackEventDelegate method)

void	addEventListener (string name, TransitionEventDelegate method)

void	addEventListener (string name, UIEventDelegate method)

void	addEventListener (string name, UserProximityEventDelegate method)

void	addEventListener (string name, WebGLContextEventDelegate method)

void	addEventListener (string name, WheelEventDelegate method)

void	addEventListener (string name, Nitro.DynamicMethod< Nitro.Void > listener)

void	addEventListener (string name, Nitro.DynamicMethod< Nitro.Void > listener, bool capture)

void	addEventListener (string name, ContextEventDelegate method)

void	addEventListener (string name, SlideEventDelegate method)

void	addEventListener (string name, PowerUI.SpriteEventDelegate method)

void	addEventListener (string name, SVGEventDelegate method)
	Adds an event listener to this document. More...

void	addEventListener (string name, SVGZoomEventDelegate method)

Public Attributes
Document	hostDocument
	A document to inform when the resource has loaded. More...

Location	redirectedTo
	A location that the request was redirected to. More...

Location	location
	The URI that was requested. More...

byte[]	request
	E.g. posted data. More...

string	type
	The type of file that was requested (e.g. "woff" or "ttf") More...

int	statusCode =200
	A HTTP status code if there is one. More...

int	contentLength
	Total content length. More...

int	bytesReceived
	Bytes received. More...

Public Attributes inherited from Dom.EventTarget
EventsSet	Events
	A set of events for this document. See addEventListener. More...

Protected Member Functions
void	SetPath (string src, Location relativeTo)
	Sets up the filepath to the given url which may be relative to a given location. More...

Protected Member Functions inherited from Dom.EventTarget
T	GetFirstDelegate< T > (string name)
	Gets the first delegate event handler for the given event name. More...

virtual bool	HandleLocalEvent (Event e, bool bubblePhase)
	Handles triggering event handlers here. Elements can (and in PowerUI's case, do) override this. PowerUI overrides it to handle e.g. onclick="" attributes too. More...

Package Functions
bool	ReceivedHeaders ()
	All headers are ready. Returns true if we're redirecting. More...

void	ReceivedHeaders (int length)
	All headers are ready. More...

bool	ReceivedHeaders (string rawHeaders)
	All headers are ready. Returns true if we're redirecting. More...

void	Done ()
	Goes straight to ready state 4, status 200. More...

virtual void	ReceivedData (byte[] buffer, int offset, int count)
	Received a block of data. More...

virtual void	ReceivedMovieTexture (UnityEngine.MovieTexture tex)

Package Attributes
int	readyState_
	Same as XMLHTTPRequest.readyState. More...

IAbortable	abortableObject
	An internal abortable object. More...

Properties
int	readyState `[get, set]`
	Same as XMLHTTPRequest.readyState. More...

Headers	requestHeaders `[get]`
	The headers to send with this request. They're lowercase. Status line is indexed as the empty string. More...

Headers	responseHeaders `[get]`
	All available headers, parsed as soon as they become available. Status line is indexed as the empty string. More...

string	rawResponseHeaders `[get, set]`
	Gets or sets the raw response headers. More...

string	rawRequestHeaders `[get, set]`
	Gets or sets the raw response headers. More...

string	statusText `[get]`
	The complete response status header. E.g. "HTTP/1.1 200 OK" More...

bool	started `[get]`
	True if this request has started up. More...

bool	ready `[get]`
	True if this request has at least some data. More...

bool	ok `[get]`
	True if there is no error and the text is ok. More...

bool	errored `[get]`
	True if there was an error and the text is not ok. More...

string	contentType `[get]`
	The response content type. More...

float	progress `[get]`
	Download progress. More...

int	timeout `[get, set]`
	Timeout in ms. Default is 0. More...

UIEventDelegate	onreadystatechange `[get, set]`
	Called when the ready state changes. More...

UIEventDelegate	onload `[get, set]`
	Called when it's done loading. More...

UIEventDelegate	ontimeout `[get, set]`
	Called when the request times out. More...

UIEventDelegate	onerror `[get, set]`
	Called when the request errors. More...

UIEventDelegate	onabort `[get, set]`
	Called when the request is aborted. More...

Properties inherited from Dom.EventTarget
static DispatchStack	dispatchStackRef `[get]`
	The active dispatch stack. Use event.deepPath to access it (available during dispatch only). More...

virtual EventTarget	eventTargetParentNode `[get]`
	The parent node as used by EventTarget during capture. Can be null. More...

virtual NodeList	eventTargetChildren `[get]`
	The childNode set as used by EventTarget during capture. Can be null. More...

Private Member Functions
bool	LoadStatusAndLength ()
	Sets up status code and contentLength from the headers. Returns true if we're redirecting. More...

Private Attributes
Headers	requestHeaders_
	The internal request headers. See requestHeaders. More...

Headers	responseHeaders_
	The internal response headers. See responseHeaders. More...

Additional Inherited Members
Static Package Attributes inherited from Dom.EventTarget
static DispatchStack	PooledStack
	The current head of the pooled dispatched stacks. More...

Member Function Documentation

void PowerUI.ContentPackage.abort ( )

inline

Aborts this request.

void PowerUI.ContentPackage.AttachForm ( UnityEngine.WWWForm form)

inline

Adds the given form to this request. Note that if you wish to also use custom headers with a form, call this first. Then, add to the Headers property.

Parameters

form	The form to attach to this request.

void PowerUI.ContentPackage.Done ( )

inlinepackage

Goes straight to ready state 4, status 200.

void PowerUI.ContentPackage.Failed ( int status)

inline

Goes straight to ready state 4 and the given status.

bool PowerUI.ContentPackage.GetRange	(	out int	start,
		out int	end
	)

inline

Gets the range request header.

bool PowerUI.ContentPackage.LoadStatusAndLength ( )

inlineprivate

Sets up status code and contentLength from the headers. Returns true if we're redirecting.

void PowerUI.ContentPackage.NotModified ( CachedContent cacheEntry)

inline

A 304 not modified response.

virtual void PowerUI.ContentPackage.ReceivedData	(	byte[]	buffer,
		int	offset,
		int	count
	)

inlinepackagevirtual

Received a block of data.

Parameters

buffer The data that was recieved.

Reimplemented in PowerUI.ImagePackage, PowerUI.AudioPackage, and PowerUI.DataPackage.

bool PowerUI.ContentPackage.ReceivedHeaders ( )

inlinepackage

All headers are ready. Returns true if we're redirecting.

void PowerUI.ContentPackage.ReceivedHeaders ( int length)

inlinepackage

All headers are ready.

bool PowerUI.ContentPackage.ReceivedHeaders ( string rawHeaders)

inlinepackage

All headers are ready. Returns true if we're redirecting.

virtual void PowerUI.ContentPackage.ReceivedMovieTexture ( UnityEngine.MovieTexture tex)

inlinepackagevirtual

void PowerUI.ContentPackage.SetPartialResponse	(	int	start,
		int	end,
		int	total
	)

inline

Sets the Content-Range response.

void PowerUI.ContentPackage.SetPath	(	string	src,
		Location	relativeTo
	)

inlineprotected

Sets up the filepath to the given url which may be relative to a given location.

Parameters

src	The file to get.
relativeTo	The path the file to get is relative to, if any. May be null.

void PowerUI.ContentPackage.setRequestBody ( Json.JSObject toPost)

inline

Sets the PostData from the given JSON object. Changes the content type too.

void PowerUI.ContentPackage.setRequestBody ( string toPost)

inline

Sets the PostData from the given UTF8 string.

Parameters

toPost The string to POST.

void PowerUI.ContentPackage.TimedOut ( )

inline

The request has timed out.

Member Data Documentation

IAbortable PowerUI.ContentPackage.abortableObject

package

An internal abortable object.

int PowerUI.ContentPackage.bytesReceived

Bytes received.

int PowerUI.ContentPackage.contentLength

Total content length.

Document PowerUI.ContentPackage.hostDocument

A document to inform when the resource has loaded.

Location PowerUI.ContentPackage.location

The URI that was requested.

int PowerUI.ContentPackage.readyState_

package

Same as XMLHTTPRequest.readyState.

Location PowerUI.ContentPackage.redirectedTo

A location that the request was redirected to.

byte [] PowerUI.ContentPackage.request

E.g. posted data.

Headers PowerUI.ContentPackage.requestHeaders_

private

The internal request headers. See requestHeaders.

Headers PowerUI.ContentPackage.responseHeaders_

private

The internal response headers. See responseHeaders.

int PowerUI.ContentPackage.statusCode =200

A HTTP status code if there is one.

string PowerUI.ContentPackage.type

The type of file that was requested (e.g. "woff" or "ttf")

Property Documentation

string PowerUI.ContentPackage.contentType

get

The response content type.

bool PowerUI.ContentPackage.errored

get

True if there was an error and the text is not ok.

bool PowerUI.ContentPackage.ok

get

True if there is no error and the text is ok.

UIEventDelegate PowerUI.ContentPackage.onabort

getset

Called when the request is aborted.

UIEventDelegate PowerUI.ContentPackage.onerror

getset

Called when the request errors.

UIEventDelegate PowerUI.ContentPackage.onload

getset

Called when it's done loading.

UIEventDelegate PowerUI.ContentPackage.onreadystatechange

getset

Called when the ready state changes.

UIEventDelegate PowerUI.ContentPackage.ontimeout

getset

Called when the request times out.

float PowerUI.ContentPackage.progress

get

Download progress.

string PowerUI.ContentPackage.rawRequestHeaders

getset

Gets or sets the raw response headers.

string PowerUI.ContentPackage.rawResponseHeaders

getset

Gets or sets the raw response headers.

bool PowerUI.ContentPackage.ready

get

True if this request has at least some data.

int PowerUI.ContentPackage.readyState

getset

Same as XMLHTTPRequest.readyState.

Headers PowerUI.ContentPackage.requestHeaders

get

The headers to send with this request. They're lowercase. Status line is indexed as the empty string.

Headers PowerUI.ContentPackage.responseHeaders

get

All available headers, parsed as soon as they become available. Status line is indexed as the empty string.

bool PowerUI.ContentPackage.started

get

True if this request has started up.

string PowerUI.ContentPackage.statusText

get

The complete response status header. E.g. "HTTP/1.1 200 OK"

int PowerUI.ContentPackage.timeout

getset

Timeout in ms. Default is 0.

Detailed Description

Public Member Functions

Public Attributes

Protected Member Functions

Package Functions

Package Attributes

Properties

Private Member Functions

Private Attributes

Additional Inherited Members

Member Function Documentation

Member Data Documentation

Property Documentation