import {WacDataPipe} from '@quobis/sippojs'

public class | source

WacDataPipe

Extends:

eventemitter2~EventEmitter2 → DataPipe → WacDataPipe

Constructor Summary

Public Constructor
public	constructor()

Member Summary

Public Members
public	datapipeService: *
public	gatewayUsername: *
public	internalId: *
public	status: *

Method Summary

Public Methods
public	async connect(): *
public	async disconnect(): *
public	async reject(): *
public	async send(data: ):

Inherited Summary

From class DataPipe
public get	id: String Gets a unique identifier for the pipe
public get	label: String Return label associated with this DataPipe.
public get	participants: Array<String> Gets the identities of the peers attached to this pipe
public get	remoteParticipants: Array<String> Gets the identities of the remote peers attached to this pipe
public get	status: DataPipeStatus Retrieves the current status of this pipe.
public get	type: DataPipe.TYPE Gets pipe type
public	[priv.id]: *
public	[priv.internalId]: *
public	[priv.label]: *
public	[priv.participants]: *
public	[priv.stack]: *
public	[priv.status]: *
public	[priv.type]: *
public	addParticipant(identity: String): Promise<DataPipe, Error> Adds a participant to this pipe.
public	connect(): Promise<DataPipe, Error> Attempts to reach the pipe recipient and establish a connection.
public	disconnect(): Promise<DataPipe, Error> Ends an active pipe.
public	reject(): Promise<DataPipe, Error> Called when a user does not wish to accept an incoming pipe.
public	removeParticipant(identity: String): Promise<DataPipe, Error> Removes a participant from this pipe.
public	send(data: String): Promise<DataPipe, Error> Sends data to the DataPipe recipients
public	when(status: DataPipeStatus): Promise<DataPipe, Error> Returns a Promise resolved when pipe reaches provided state

Public Constructors

public constructor() source

Public Members

public datapipeService: * source

public gatewayUsername: * source

public internalId: * source

public status: * source

Retrieves the current status of this pipe.

Override:

DataPipe#status

Public Methods

public async connect(): * source

Attempts to reach the pipe recipient and establish a connection. For an incoming pipe, calling this method explicitly joins/accepts the pipe.

When this method fails returned {Promise} is rejected with one of next {Error}

'unimplemented'
'invalid-state' error when called on state different than "unconnected" state
'disconnected' pipe reaches disconnected state without being connected

Override:

DataPipe#connect

Return:

public async disconnect(): * source

Ends an active pipe.

When this method fails returned {Promise} is rejected with one of next {Error}

'unimplemented'
'invalid-state' error when called on state different than "connected" state

Override:

DataPipe#disconnect

Return:

public async reject(): * source

Called when a user does not wish to accept an incoming pipe.

When this method fails returned {Promise} is rejected with one of next {Error}

'unimplemented'
'invalid-state' error when called on state different than "unconnected" state
'invalid-state' error when called on outgoing pipes

Override:

DataPipe#reject

Return:

public async send(data: ): source

Sends data to the DataPipe recipients

When this method fails returned {Promise} is rejected with one of next {Error}

'unimplemented'
'invalid-state' error when called on state different than "connected" state

Override:

DataPipe#send

Params:

Name	Type	Attribute	Description
data	*

WacDataPipe

Extends:

Constructor Summary

Member Summary

Method Summary

Inherited Summary

Public Constructors

public constructor() source

Public Members

public datapipeService: * source

public gatewayUsername: * source

public internalId: * source

public status: * source

Override:

Public Methods

public async connect(): * source

Override:

Return:

public async disconnect(): * source

Override:

Return:

public async reject(): * source

Override:

Return:

public async send(data: *): * source

Override:

Params:

Return:

public async send(data: ): source