import Invite from 'webcom-reach/src/core/Invite.js'

public class | source

Invite

Invitation

Member Summary

Public Members
public	from: string Invite's sender uid
public get	isAccepted: boolean Was this invitation accepted ?
public get	isCanceled: boolean Was this invitation canceled ?
public get	isOnGoing: boolean Is this invitation waiting for a reply ?
public get	isRejected: boolean Was this invitation rejected ?
public	room: string The id of the room associated to the invite
public	status: string The invitation status : ONGOING - The receiver has not yet responded to the invitation ACCEPTED - The receiver has accepted the invitation REJECTED - The receiver has rejected the invitation CANCELED - The sender canceled the invitation
public	to: string Invitee's uid
public	topic: string Invite message.
public	uid: * Invite's unique id

Method Summary

Public Methods
public	accept(): Promise<Invite> Accept the invitation.
public	cancel(reason: string): Promise<Invite> Cancels the invitation.
public	off(status: string, callback: function) Un-register a callback for a status update
public	offStatusChange(callback: function) Un-register a callback for all status change events
public	on(status: string, callback: function) Register a callback for a status update
public	onStatusChange(callback: function) Register a callback for all status change events
public	reject(reason: string): Promise<Invite> Rejects the invitation.

Public Members

public from: string source

Invite's sender uid

public get isAccepted: boolean source

Was this invitation accepted ?

public get isCanceled: boolean source

Was this invitation canceled ?

public get isOnGoing: boolean source

Is this invitation waiting for a reply ?

public get isRejected: boolean source

Was this invitation rejected ?

public room: string source

The id of the room associated to the invite

public status: string source

The invitation status :

ONGOING - The receiver has not yet responded to the invitation
ACCEPTED - The receiver has accepted the invitation
REJECTED - The receiver has rejected the invitation
CANCELED - The sender canceled the invitation

public to: string source

Invitee's uid

public topic: string source

Invite message. This will be either a custom message, if the status is ONGOING or a reason when status is CANCELED|REJECTED.

public uid: * source

Invite's unique id

Public Methods

public accept(): Promise<Invite> source

Accept the invitation. Only the receiver can accept the invitation.

Return:

Promise<Invite>

public cancel(reason: string): Promise<Invite> source

Cancels the invitation. Only the sender can cancel the invitation.

Params:

Name	Type	Attribute	Description
reason	string	optional	The reason the sender is canceling the invite

Return:

Promise<Invite>

public off(status: string, callback: function) source

Un-register a callback for a status update

Params:

Name	Type	Attribute	Description
status	string	optional	Can be: ACCEPTED REJECTED CANCELED null This will un-register all callbacks
callback	function	optional

Name

Type

Attribute

Description

status

string

optional

Can be:

ACCEPTED
REJECTED
CANCELED
null This will un-register all callbacks

callback

function

optional

public offStatusChange(callback: function) source

Un-register a callback for all status change events

Params:

Name	Type	Attribute	Description
callback	function	optional

public on(status: string, callback: function) source

Params:

Name	Type	Attribute	Description
status	string		Can be: ACCEPTED REJECTED CANCELED
callback	function

Name

Type

Attribute

Description

status

string

Can be:

ACCEPTED
REJECTED
CANCELED

callback

function

public onStatusChange(callback: function) source

Params:

Name	Type	Attribute	Description
callback	function

public reject(reason: string): Promise<Invite> source

Rejects the invitation. Only the receiver can reject the invitation.

Params:

Name	Type	Attribute	Description
reason	string	optional	The reason the receiver is rejecting the invite

Return:

Promise<Invite>