Documentation

Class: ReceivedFileTransferInvitation

ReceivedFileTransferInvitation

ReceivedFileTransferInvitation

Defines an invitation received by this client for a call

new ReceivedFileTransferInvitation()

Fires:

Extends

Methods

<static> getAvailableEvents()

Returns available events for this class

Returns:
Type
Array.<string>

accept()

Accepts this invitation & notifies sender

Overrides:
Returns:

{file, name, type} received an object with file, file name and file type parameters in promise

Type
Promise.<Object>

decline()

Declines this invitation & notifies sender

Overrides:
Returns:
Type
Void

getFileInfo()

Returns file information

Returns:
Type
FileInfo

getId()

Returns invitation id

Inherited From:
Overrides:
Returns:
Type
string

getReceiveTime()

Returns invitation receive time

Inherited From:
Overrides:
Returns:
Type
Date

getSender()

Returns invitation / request sender

Inherited From:
Overrides:
Returns:
Type
Contact

on(listener)

Adds a listener to a Observable event

Parameters:
Name Type Description
listener function
Inherited From:
Overrides:
Returns:

this instance for chaining

Type
Observable

removeListener(eventType, listener)

Remove existing listener to Observable event

Parameters:
Name Type Description
eventType String
listener function
Inherited From:
Overrides:
Returns:

this instance for chaining

Type
Observable

Events

error

When an error occured during file transfer

Type: Error

progress

Emitted periodically during file transfer and contains file transfer progression information

Type: TransferInformation

statusChange

Emitted invitation status change

Type: StatusChangeInfo
Inherited From:
Overrides: