Documentation

Class: ReceivedRemoteAccessInvitation

ReceivedRemoteAccessInvitation

ReceivedRemoteAccess Invitation

Defines an invitation received by this client for a call

new ReceivedRemoteAccessInvitation()

Extends

Methods

<static> getAvailableEvents()

Returns available events for this class

Returns:
Type
Array.<string>

accept()

Accepts this invitation & notifies sender

Overrides:
Returns:

roomId in promise

Type
Promise.<string>

decline()

Declines this invitation & notifies sender

Overrides:
Returns:
Type
Promise.<String>

downloadApplication()

Download remote access application

Returns:
Type
Promise.<void>

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

sendMessageToSender(eventType, messageData)

Send Message to remote access contact

Parameters:
Name Type Description
eventType String
messageData JSON
Returns:
Type
Promise.<void>

startScreenSharingAndPublish()

Start remote access screen sharing stream and publish it to the conversation

Returns:
Type
Promise.<Stream>

stop(sendMessage,, reason,)

Used to stop the remote access process

Parameters:
Name Type Description
sendMessage, Boolean

used to set if stop message need to be sent to the remote
reason, StopReason

Optional - used to exchange stop reason information, apiRTC already define several reason.
This reason is fired on stop event
Returns:

void

Events

statusChange

Emitted invitation status change

Type: StatusChangeInfo
Inherited From:
Overrides: