InvitationsService for Version 1.66.1

InvitationsService

This services manages the invitations received/ sent from/to server.

Access: public
Version: 1.66.1

• InvitationsService
  • .getAllInvitationsNumber() ⇒ Array.<Invitation>
  • .getReceivedInvitations() ⇒ Array.<Invitation>
  • .getAcceptedInvitations() ⇒ Array.<Invitation>
  • .getSentInvitations() ⇒ Array.<Invitation>
  • .getInvitationsNumberForCounter() ⇒ Array.<Invitation>
  • .getInvitation(invitationId) ⇒ Invitation
  • .joinContactInvitation(contact) ⇒ Object
  • .sendInvitationByEmail(email, [customMessage]) ⇒ Object
  • .cancelOneSendInvitation(invitation) ⇒ Object
  • .reSendInvitation(invitationId) ⇒ Object
  • .sendInvitationByEmail(listOfMails) ⇒ Object
  • .acceptInvitation(invitation) ⇒ Object
  • .declineInvitation(invitation) ⇒ Object

invitationsService.getAllInvitationsNumber() ⇒ Array.<Invitation>

Get the number of invitations sent/received to/from others Rainbow users

Kind: instance method of InvitationsService
Returns: Array.<Invitation> - The list of invite sent
Access: public
Since: 1.65

invitationsService.getReceivedInvitations() ⇒ Array.<Invitation>

Get the invite received coming from Rainbow users

Kind: instance method of InvitationsService
Returns: Array.<Invitation> - The list of invitations received
Access: public
Since: 1.65

invitationsService.getAcceptedInvitations() ⇒ Array.<Invitation>

Get the invites you accepted received from others Rainbow users

Kind: instance method of InvitationsService
Returns: Array.<Invitation> - The list of invite sent
Access: public
Since: 1.65

invitationsService.getSentInvitations() ⇒ Array.<Invitation>

Get the invites sent to others Rainbow users

Kind: instance method of InvitationsService
Returns: Array.<Invitation> - The list of invite sent
Access: public
Since: 1.65

invitationsService.getInvitationsNumberForCounter() ⇒ Array.<Invitation>

Get the number of invitations received from others Rainbow users

Kind: instance method of InvitationsService
Returns: Array.<Invitation> - The list of invite sent
Access: public
Since: 1.65

invitationsService.getInvitation(invitationId) ⇒ Invitation

Get an invite by its id

Kind: instance method of InvitationsService
Returns: Invitation - The invite if found
Access: public
Since: 1.65

Param	Type	Description
invitationId	String	the id of the invite to retrieve

invitationsService.joinContactInvitation(contact) ⇒ Object

Accept a an invitation from an other Rainbow user to mutually join the network
Once accepted, the user will be part of your network.
Return a promise

Kind: instance method of InvitationsService
Returns: Object - A promise that contains SDK.OK if success or an object that describes the error
Access: public
Since: 1.65

Param	Type	Description
contact	Contact	The invitation to accept

invitationsService.sendInvitationByEmail(email, [customMessage]) ⇒ Object

Send an invitation email as UCaaS

Kind: instance method of InvitationsService
Returns: Object - A promise that contains the contact added or an object describing an error
Access: public
Since: 1.65

Param	Type	Description
email	string	The email
[customMessage]	string	The email text (optional)

invitationsService.cancelOneSendInvitation(invitation) ⇒ Object

Cancel an invitation sent

Kind: instance method of InvitationsService
Returns: Object - The SDK Ok object or an error
Access: public
Since: 1.65

Param	Type	Description
invitation	Invitation	The invitation to cancel

invitationsService.reSendInvitation(invitationId) ⇒ Object

Re send an invitation sent

Kind: instance method of InvitationsService
Returns: Object - The SDK Ok object or an error
Access: public
Since: 1.65

Param	Type	Description
invitationId	Number	The invitation to re send

invitationsService.sendInvitationByEmail(listOfMails) ⇒ Object

Send invitations for a list of emails as UCaaS LIMITED TO 100 invitations

Kind: instance method of InvitationsService
Returns: Object - A promise that the invite result or an object describing an error
Access: public
Since: 1.65

Param	Type	Description
listOfMails	Array	The list of emails

invitationsService.acceptInvitation(invitation) ⇒ Object

Accept a an invitation from an other Rainbow user to mutually join the network
Once accepted, the user will be part of your network.
Return a promise

Kind: instance method of InvitationsService
Returns: Object - A promise that contains SDK.OK if success or an object that describes the error
Access: public
Since: 1.65

Param	Type	Description
invitation	Invitation	The invitation to accept

invitationsService.declineInvitation(invitation) ⇒ Object

Decline an invitation from an other Rainbow user to mutually join the network
Once declined, the user will not be part of your network.
Return a promise

Kind: instance method of InvitationsService
Returns: Object - A promise that contains SDK.OK in case of success or an object that describes the error
Access: public
Since: 1.65

Param	Type	Description
invitation	Invitation	The invitation to decline