Documentation

Class: SentRemoteAccessInvitation

SentRemoteAccessInvitation

SentRemoteAccessInvitation

Defines an invitation received by this client for a call

new SentRemoteAccessInvitation(contact, conversation, options)

Parameters:
Name Type Description
contact Contact
conversation Conversation
options JSON

Extends

Methods

<static> getAvailableEvents()

Returns available events for this class

Returns:
Type
Array.<string>

cancel()

Cancel the ongoing invitation

Inherited From:
Overrides:
Returns:
Type
Void

getId()

Returns Invitation's id

Inherited From:
Overrides:
Returns:

Invitation id

Type
string

getMouseAndKeyboardAccessStatus()

Used to get mouse and keyboard event listeners status

Returns:
Type
Boolean

getStatus()

Returns invitation status

Inherited From:
Overrides:
Returns:

invitation status

Type
Symbol

onResponse()

Adds a listener called when the Sent invitation has been answered or has expired

Inherited From:
Overrides:
Returns:
Type
Void

send(messageData)

Send Message to remote access contact

Parameters:
Name Type Description
messageData JSON
Inherited From:
Overrides:
Returns:
Type
Promise.<void>

setScreenSharingStreamDOMElementId(DOMElementId,)

Used to set mouse and keyboard event listeners

Parameters:
Name Type Description
DOMElementId, String

screen sharing stream element id
Returns:

void

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

toggleMouseAndKeyboardAccess()

Used activate/deactivate mouse and keyboard event listeners

Returns:
Type
Promise.<void>

Events

receive

When the invitation has been received by the contact

Type: Void
Inherited From:
Overrides:

response

When the invitation status changed

Type: symbol
Inherited From:
Overrides:
Deprecated:
  • Please note that this event is now deprecated as we have added a statusChange event

statusChange

Emitted invitation status change

Type: StatusChangeInfo
Inherited From:
Overrides: