bria/dist/client/Collaboration.d.ts

CounterPath Bria Desktop API for Node.js

import BriaClientLeaf from './Leaf';
import { BriaClient } from '.';
import { AccountType } from './Account';
import { PresenceType } from './Presence';
export declare type ContactId = number;
export declare type Contact = {
    id: ContactId;
    email: string[];
    fax: string[];
    home: string[];
    jid: string[];
    mobile: string[];
    other: string[];
    softphone: string[];
    website: string[];
    work: string[];
    collabUrl: string[];
    presenceStatus: PresenceType;
    presenceText: string;
    presenceAddress: string;
    presenceType: AccountType;
};
export declare type ContactTag = 'email' | 'fax' | 'home' | 'jid' | 'mobile' | 'other' | 'softphone' | 'website' | 'work' | 'collabUrl';
export declare type ScreenShareInviteeType = 'xmpp' | 'simple';
export declare type ScreenShareInvitee = {
    address: string;
    type: ScreenShareInviteeType;
};
export declare type ScreenShareSession = {
    status: string;
    joinUrl: string;
};
export declare class BriaClientCollaboration extends BriaClientLeaf {
    screenShares: ScreenShareSession[];
    constructor(client: BriaClient);
    private populateScreenShares;
    populate(): Promise<void>;
    private screenShareUpdate;
    /**
     * Open an IM session and take window focus
     * @param type
     * @param address
     * @see https://docs.counterpath.com/guides/desk/desk_api/clients/deskAPI/deskApiIM.htm#/im
     */
    createIM(type: AccountType, address: string): Promise<import("sxml").XML>;
    /**
     * Start a new collaboration conference
     * @see https://docs.counterpath.com/guides/desk/desk_api/clients/deskAPI/deskApiConferences.htm#startCollab
     */
    startCollab(): Promise<import("sxml").XML>;
    /**
     * Join an existing collaboration conference
     * @param collabUrl
     * @see https://docs.counterpath.com/guides/desk/desk_api/clients/deskAPI/deskApiConferences.htm#joinCollab
     */
    joinCollab(collabUrl: string): Promise<import("sxml").XML>;
    /**
     * Get contact information
     * @param address Email address
     * @see https://docs.counterpath.com/guides/desk/desk_api/clients/deskAPI/deskApiContactsPresence.htm#getStatusContact
     */
    getContact(address: string): Promise<Contact>;
    /**
     * Screenshare invitees
     * @param invitees type = 'simple' for SIP, xmpp for jabber
     * @see https://docs.counterpath.com/guides/desk/desk_api/clients/deskAPI/deskApiScreenSharing.htm#getStartScreenShare
     */
    startScreenShare(invitees: ScreenShareInvitee[]): Promise<import("sxml").XML>;
    /**
     * Get active screenshares
     * @see https://docs.counterpath.com/guides/desk/desk_api/clients/deskAPI/deskApiScreenSharing.htm#getStatusScreenShare
     */
    getScreenShares(): Promise<ScreenShareSession[]>;
}
//# sourceMappingURL=Collaboration.d.ts.map