Class DataPipe

constructor

• new DataPipe(): DataPipe

• Returns DataPipe

id

label

participants

remoteParticipants

status

type

addParticipant

• addParticipant(identity): Promise<DataPipe>

• Adds a participant to this pipe.

  Parameters

  • identity: string

  Returns Promise<DataPipe>

connect

• connect(): Promise<DataPipe>

• Attempts to reach the pipe recipient and establish a connection.

  Returns Promise<DataPipe>

disconnect

• disconnect(): Promise<DataPipe>

• Ends an active pipe.

  Returns Promise<DataPipe>

on

• on(event, callback): void

• Attach events to callback functions.

  Parameters

  • event: string
  • callback: ((param) => void)
    • • (param): void

      • Parameters

        • param: any

        Returns void

  Returns void

reject

• reject(): Promise<DataPipe>

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

  Returns Promise<DataPipe>

removeParticipant

• removeParticipant(identity): Promise<DataPipe>

• Removes a participant from this pipe.

  Parameters

  • identity: string

  Returns Promise<DataPipe>

send

• send(data): Promise<DataPipe>

• Sends data to the DataPipe recipients

  Parameters

  • data: string

  Returns Promise<DataPipe>

when

• when(status): Promise<DataPipe>

• Returns a Promise resolved when pipe reaches provided state

  Parameters

  • status: DataPipeStatus

  Returns Promise<DataPipe>