UIZE JavaScript Framework

MODULES Uize.Comm.Script

SEARCHEXAMPLESSOURCEDEPSTEST

1. Introduction

The Uize.Comm.Script class implements support for communication with a server via cross-site scripting through the insertion of script tags into the document.

DEVELOPERS: Tim Carter

In order to implement support for communication through script tags, this class overrides the implementation of the performRequest instance method inherited from the Uize.Comm base class. There are no additional methods provided by this class - all the interface is provided in the Uize.Comm superclass.

1.1. Examples

There are no dedicated showcase example pages for the Uize.Comm.Script module.

SEARCH FOR EXAMPLES

Use the link below to search for example pages on the UIZE Web site that reference the Uize.Comm.Script module...

SEARCH

1.2. Implementation Info

The Uize.Comm.Script module defines the Uize.Comm.Script class, which is a subclass of Uize.Comm.

INHERITANCE CHAIN

Uize.Class −> Uize.Comm −> Uize.Comm.Script

1.2.1. Features Introduced in This Module

The features listed in this section have been introduced in this module.

STATE PROPERTIES

callbackMode

1.2.2. Features Overridden in This Module

The features listed in this section have been overridden in this module.

The module that an overridden feature was initially introduced in will be noted in the IMPLEMENTATION INFO notes for the feature.

INSTANCE METHODS

performRequest | valueOf

STATIC PROPERTIES

Uize.Comm.Script.moduleName | Uize.Comm.Script.nonInheritableStatics

1.2.3. Features Inherited From Other Modules

The features listed in this section have been inherited from other modules.

The module that an inherited feature was initially introduced in will be noted in the IMPLEMENTATION INFO notes for the feature.

INSTANCE METHODS

fire | flush | flushCache | get | is | isMet | kill | met | onChange | once | queueRequest | request | set | toggle | unmet | unwire | useQueue | whenever | wire

STATIC METHODS

Uize.Comm.Script.alphastructor | Uize.Comm.Script.declare | Uize.Comm.Script.doMy | Uize.Comm.Script.dualContextMethods | Uize.Comm.Script.dualContextProperties | Uize.Comm.Script.fire | Uize.Comm.Script.get | Uize.Comm.Script.instanceMethods | Uize.Comm.Script.instanceProperties | Uize.Comm.Script.mixins | Uize.Comm.Script.omegastructor | Uize.Comm.Script.processArrayAsync | Uize.Comm.Script.set | Uize.Comm.Script.singleton | Uize.Comm.Script.stateProperties | Uize.Comm.Script.staticMethods | Uize.Comm.Script.staticProperties | Uize.Comm.Script.subclass | Uize.Comm.Script.toggle | Uize.Comm.Script.unwire | Uize.Comm.Script.wire

STATIC PROPERTIES

Uize.Comm.Script.pathToResources

1.2.4. Modules Directly Under This Namespace

There are no modules directly under this namespace.

1.2.5. Unit Tests

There is no dedicated unit tests module for the Uize.Comm.Script module.

2. State Properties

2.1. callbackMode

A string, indicating whether the callback function should be handled by the server or client.

While traditional xss techniques pass the name of the callback to the server so that it can be included in the response, certain situations may arise where the server is not capable of handling the callback. For example, this may occur when some client code wishes to query a service that is built by a third-party, and thus not under the control of the client developer. In the preceding example, the developer can set the value of callbackMode to 'client' so that Uize.Comm.Script handles the callback itself.

Uize.Comm.Script does this by inserting two script nodes into the DOM each time a request is made. The first request queries the server. The second calls the callback. This implementation assumes that the script tags are written synchronously, ie., the first finishes before the second is written out; this is the case for most modern browsers. As a result, the callback only gets executed once all the data from the server is in memory.

This does place some restrictions on the callback function. Unlike most callbacks in the Uize.Comm class and subclasses, the callback in 'client' mode does not receive any parameters. Once the 'client' callback is called, the only certainty that exists with regard to the server request is that it completed. It is the responsibility of the callback developer to know the nature of that data.

2.1.1. Values

The possible values for the callbackMode state property are 'client' or 'server'. 'server' mode means that the callback function will be passed to the server and it is the server's responsibility to call it upon completion of the task. If 'client' mode is set, Uize.Comm.Script will call the callback function after each request is made.

NOTES

the initial value is 'server'

IMPLEMENTATION INFO

this feature was introduced in this module

3. Instance Methods

3.1. fire

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)

3.2. flush

Inherited from Uize.Comm.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Comm, first introduced in Uize.Comm)

3.3. flushCache

Inherited from Uize.Comm.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Comm, first introduced in Uize.Comm)

3.4. get

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)

3.5. is

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)

3.6. isMet

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)

3.7. kill

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)

3.8. met

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)

3.9. onChange

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)

3.10. once

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)

3.11. performRequest

IMPLEMENTATION INFO

this is an override of an inherited feature (implementation is in this module, first introduced in Uize.Comm)

3.12. queueRequest

Inherited from Uize.Comm.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Comm, first introduced in Uize.Comm)

3.13. request

Inherited from Uize.Comm.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Comm, first introduced in Uize.Comm)

3.14. set

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)

3.15. toggle

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)

3.16. unmet

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)

3.17. unwire

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)

3.18. useQueue

Inherited from Uize.Comm.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Comm, first introduced in Uize.Comm)

3.19. valueOf

this is an override of an inherited feature (implementation is in this module, first introduced in Uize.Class)

IMPLEMENTATION INFO

3.20. whenever

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)

3.21. wire

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)

4. Static Methods

4.1. Uize.Comm.Script.alphastructor

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

4.2. Uize.Comm.Script.declare

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

4.3. Uize.Comm.Script.doMy

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

4.4. Uize.Comm.Script.dualContextMethods

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

4.5. Uize.Comm.Script.dualContextProperties

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

4.6. Uize.Comm.Script.fire

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

4.7. Uize.Comm.Script.get

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

4.8. Uize.Comm.Script.instanceMethods

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

4.9. Uize.Comm.Script.instanceProperties

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

4.10. Uize.Comm.Script.mixins

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

4.11. Uize.Comm.Script.omegastructor

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

4.12. Uize.Comm.Script.processArrayAsync

Inherited from Uize.Comm.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Comm, first introduced in Uize.Comm)
this static feature is inherited by subclasses

4.13. Uize.Comm.Script.set

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

4.14. Uize.Comm.Script.singleton

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

4.15. Uize.Comm.Script.stateProperties

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

4.16. Uize.Comm.Script.staticMethods

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

4.17. Uize.Comm.Script.staticProperties

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

4.18. Uize.Comm.Script.subclass

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

4.19. Uize.Comm.Script.toggle

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

4.20. Uize.Comm.Script.unwire

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

4.21. Uize.Comm.Script.wire

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

5. Static Properties

5.1. Uize.Comm.Script.moduleName

IMPLEMENTATION INFO

this is an override of an inherited feature (implementation is in this module, first introduced in Uize.Class)
this static feature is inherited by subclasses

5.2. Uize.Comm.Script.nonInheritableStatics

IMPLEMENTATION INFO

this is an override of an inherited feature (implementation is in this module, first introduced in Uize.Class)
this static feature is not inherited by subclasses

5.3. Uize.Comm.Script.pathToResources

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses