Class: DataTransfer

Members

label :String

The label of the data channel indicated by this DataTransfer object.

Type:

• String

Methods

getReceiver() → {wsc.DataReceiver}

Returns the DataReceiver object of the DataTransfer. The member DataReceiver will be created when a data channel is set up successfully.

Returns:

object

Type

wsc.DataReceiver

getSender() → {wsc.DataSender}

Returns the DataSender object of the DataTransfer. The member DataSender will be created when a data channel is set up successfully.

Returns:

object

Type

wsc.DataSender

getState() → {String}

Returns a string indicating the status of the DataTransfer object.
It can return one of the following values:

• none: The DataTransfer object is created but no data channel is established or initializing.
• starting: The data channel is initializing or in negotiation to be established.
• open: The data channel is established successfully and the ready state of the data channel is open.
• closed: The data channel has been closed.

Returns:

"none", "starting", "open," or "closed"

Type

String

Events

onClose

Event handler called when the dataChannel of a DataTransfer object is closed. An event is provided as parameter, when the handler is invoked.

Example

 function onDataTransfer(dataTransfer) {
   console.log("Data transfer call back is called!");
   // Keep the dataTransfer reference, and initialize the dataTransfer callback functions...
   myDataTransfer = dataTransfer;
   myDataTransfer.onOpen = onDCOpen;
   myDataTransfer.onError = onDCError;
   myDataTransfer.onClose = onDCClose;
 }

 function onDCClose(evt) {
   // Render the web page when the data channel is closed.
 }

onError

Event handler called when the dataChannel of a DataTransfer object encounters an error. An event is provided as parameter, when the handler is invoked.

Example

 function onDataTransfer(dataTransfer) {
   console.log("Data transfer call back called.");
   // Keep the dataTransfer reference, and initialize the dataTransfer callback functions...
   myDataTransfer = dataTransfer;
   myDataTransfer.onOpen = onDCOpen;
   myDataTransfer.onError = onDCError;
   myDataTransfer.onClose = onDCClose;
 }

 function onDCError(evt) {
   // Handle the error, and render the web page as appropriate.
 }

onOpen

Event handler called when the dataChannel of a DataTransfer object is opened. An event is provided as parameter, when the handler is invoked.

Example

 function onDataTransfer(dataTransfer) {
   console.log("Data transfer call back is called!");
   //Keep the reference of dataTransfer, and initial the callback functions of dataTransfer.
   myDataTransfer = dataTransfer;
   myDataTransfer.onOpen = onDCOpen;
   myDataTransfer.onError = onDCError;
   myDataTransfer.onClose = onDCClose;
 }

 function onDCOpen(evt) {
   //Do some render for web page when data channel is open.
 }