Class BriaClientCollaboration

Hierarchy

default
- BriaClientCollaboration

Index

Constructors

constructor

Properties

screenShares

Methods

Constructors

constructor

new BriaClientCollaboration(client: BriaClient): BriaClientCollaboration

Overrides default.constructor
- Defined in client/Collaboration.ts:57
Parameters
- client: BriaClient
Returns BriaClientCollaboration

Properties

screenShares

screenShares: ScreenShareSession[] = []

Methods

createIM

createIM(type: AccountType, address: string): Promise<XML>

- Defined in client/Collaboration.ts:79
Open an IM session and take window focus

see
https://docs.counterpath.com/guides/desk/desk_api/clients/deskAPI/deskApiIM.htm#/im

Parameters
- type: AccountType
- address: string
Returns Promise<XML>

getContact

getContact(address: string): Promise<Contact>

- Defined in client/Collaboration.ts:105
Get contact information

see
https://docs.counterpath.com/guides/desk/desk_api/clients/deskAPI/deskApiContactsPresence.htm#getStatusContact

Parameters
- address: string
  
  Email address
Returns Promise<Contact>

getScreenShares

getScreenShares(): Promise<ScreenShareSession[]>

- Defined in client/Collaboration.ts:168
Get active screenshares

see
https://docs.counterpath.com/guides/desk/desk_api/clients/deskAPI/deskApiScreenSharing.htm#getStatusScreenShare

Returns Promise<ScreenShareSession[]>

joinCollab

joinCollab(collabUrl: string): Promise<XML>

- Defined in client/Collaboration.ts:96
Join an existing collaboration conference

see
https://docs.counterpath.com/guides/desk/desk_api/clients/deskAPI/deskApiConferences.htm#joinCollab

Parameters
- collabUrl: string
Returns Promise<XML>

populate

populate(): Promise<void>

Overrides default.populate
- Defined in client/Collaboration.ts:66
Returns Promise<void>

startCollab

startCollab(): Promise<XML>

- Defined in client/Collaboration.ts:87
Start a new collaboration conference

see
https://docs.counterpath.com/guides/desk/desk_api/clients/deskAPI/deskApiConferences.htm#startCollab

Returns Promise<XML>

startScreenShare

startScreenShare(invitees: ScreenShareInvitee[]): Promise<XML>

- Defined in client/Collaboration.ts:160
Screenshare invitees

see
https://docs.counterpath.com/guides/desk/desk_api/clients/deskAPI/deskApiScreenSharing.htm#getStartScreenShare

Parameters
- invitees: ScreenShareInvitee[]
  
  type = 'simple' for SIP, xmpp for jabber
Returns Promise<XML>

Generated using TypeDoc