@vonage/client-sdk 1.1.0-alpha.5 → 1.1.0-alpha.7

package/dist/client/VonageClient.d.ts

@@ -24,6 +24,10 @@ export declare const LegStatus: typeof vonage.LegStatusJS;
 export type CallSayParams = Partial<vonage.CallSayParams> & {
     text: string;
 };
+type JSONValue = string | number | boolean | {
+    [x: string]: JSONValue;
+} | JSONValue[];
+import { Conversation, ConversationsPage, EventsPage, Member, MembersPage, PresentingOrder } from '../utils';
 export declare const setVonageClientLoggingLevel: typeof vonage.setDefaultLoggingLevel;
 /**
  * VonageClient is the main entry point for the Vonage Client SDK.
@@ -46,13 +50,39 @@ export declare class VonageClient extends vonage.CombinedClientJS {
     /**
      * Register a callback for an event.
      *
-     * NOTE: you can only register one callback per event.
-     *
      * @param event - the event to register for (e.g. 'legStatusUpdate')
      * @param callback - the callback to register for the event
+     * @returns a symbol that can be used to unregister the callback
+     * @remarks
+     * Besure to store the symbol returned by this method so you can unregister the callback later.
+     * We recommend deregistering callbacks when you no longer need them. See {@link off}.
+     */
+    on<T extends keyof VonageEvent, Fn extends VonageEvent[T]>(event: T, callback: Fn): symbol;
+    /**
+     * Unregister a callback for an event.
+     *
+     * @param event - the event to register for (e.g. 'legStatusUpdate')
+     * @param callbackSymbol - the callback symbol to unregister
+     * @returns true if the callback was unregistered, false otherwise
+     * @remarks
+     * We recommend deregistering callbacks when you no longer need them.
+     */
+    off<T extends keyof VonageEvent>(event: T, callbackSymbol: symbol): boolean;
+    /**
+     * Clear all callbacks for an event.
+     *
+     * @param event - the event to register for (e.g. 'legStatusUpdate')
      * @returns void
+     *
+     * @remarks
+     * This is useful for cleaning up callbacks when you no longer need them.
+     *
+     * @example
+     * ```ts
+     *    client.clearCallbacks('legStatusUpdate');
+     * ```
      */
-    on<T extends keyof VonageEvent, Fn extends VonageEvent[T]>(event: T, callback: Fn): void;
+    clearCallbacks<T extends keyof VonageEvent>(event: T): void;
     /**
      * Create a session with a token and optional sessionId
      * If no sessionId is provided, a new one will be generated
@@ -98,5 +128,92 @@ export declare class VonageClient extends vonage.CombinedClientJS {
      * @returns void
      */
     say(callId: string, params: CallSayParams): Promise<void>;
+    /**
+     * Get a list of Conversations for the user.
+     *
+     * @param order - the order to return the conversations in (default: 'asc')
+     * @param pageSize - the number of conversations to return per page (default: 100)
+     * @param cursor - the cursor to use for pagination (default: null)
+     * @returns a `ConversationsPage` containing the conversations
+     */
+    getConversations(order?: PresentingOrder, pageSize?: number, cursor?: string | null): Promise<ConversationsPage>;
+    /**
+     * Get a Conversation's Events
+     *
+     * @param id - the Conversation's id
+     * @param order - the order to return the events in (default: 'asc')
+     * @param pageSize - the number of events to return per page (default: 100)
+     * @param cursor - the cursor to use for pagination (default: null)
+     * @returns a `EventsPage` containing the events
+     */
+    getConversationEvents(id: string, order?: PresentingOrder, pageSize?: number, cursor?: string | null): Promise<EventsPage>;
+    /**
+     * Get a Conversation's Members
+     * @param id - the Conversation's id
+     * @param order - the order to return the members in (default: 'asc')
+     * @param pageSize - the number of members to return per page (default: 100)
+     * @param cursor - the cursor to use for pagination (default: null)
+     * @returns a `MembersPage` containing the members
+     */
+    getConversationMembers(id: string, order?: PresentingOrder, pageSize?: number, cursor?: string | null): Promise<MembersPage>;
+    /**
+     * Create a conversation
+     * @param name - the name of the conversation
+     * @param displayName - the display name of the conversation
+     * @returns the `cid` of the conversation
+     */
+    createConversation(name?: string, displayName?: string): Promise<string>;
+    /**
+     * Get a Conversation
+     * @param id - the Conversation's id
+     * @returns the `Conversation`
+     */
+    getConversation(cid: string): Promise<Conversation>;
+    /**
+     * Leave a Conversation
+     * @param id - the Conversation's id
+     * @returns void
+     */
+    leaveConversation(id: string): Promise<void>;
+    /**
+     * Join a Conversation
+     * @param id - the Conversation's id
+     * @returns the `memberId` of the member
+     */
+    joinConversation(id: string): Promise<string>;
+    /**
+     * Delete a Conversation
+     * @param id - the Conversation's id
+     * @returns void
+     */
+    deleteConversation(id: string): Promise<void>;
+    /**
+     * Invite a user to a Conversation by user's `name`
+     * @param id - the Conversation's id
+     * @param name - the namne of the user to invite
+     * @returns the `memberId` of the member
+     */
+    inviteToConversation(id: string, name: string): Promise<string>;
+    /**
+     * Send a text message to a Conversation
+     * @param id - the Conversation's id
+     * @param text - the Body of the message
+     * @returns the `timestamp` of the message
+     */
+    sendTextMessage(id: string, text: string): Promise<string>;
+    /**
+     * Send a custom message to a Conversation
+     * @param id - the Conversation's id
+     * @param customData - the body of the message
+     * @returns the `timestamp` of the message
+     */
+    sendCustomMessage(id: string, customData: JSONValue): Promise<string>;
+    /**
+     * Get a Member of a Conversation
+     * @param cid - the Conversation's id
+     * @param mid - the Member's id
+     * @returns the `Member`
+     */
+    getConversationMember(cid: string, mid: string): Promise<Member>;
 }
 export default VonageClient;