@sudoplatform/sudo-secure-communications 5.0.2 → 5.1.0

package/types/public/modules/messagingModule.d.ts

@@ -310,6 +310,34 @@ export interface GetPollResponsesInput {
     recipient: Recipient;
     pollId: string;
 }
+/**
+ * Properties required to register a timeline listener.
+ *
+ * @interface RegisterEventListenerInput
+ * @property {HandleId} handleId The identifier of the handle owned by this client.
+ * @property {Recipient} recipient The target recipient.
+ * @property {string} name The name of the listener.
+ * @property {TimelineListener} listener The listener to register.
+ */
+export interface RegisterMessageListenerInput {
+    handleId: HandleId;
+    recipient: Recipient;
+    name: string;
+    listener: (message: Message) => void;
+}
+/**
+ * Properties required to unregister a timeline listener.
+ *
+ * @interface UnregisterTimelineListenerInput
+ * @property {HandleId} handleId The identifier of the handle owned by this client.
+ * @property {Recipient} recipient The target recipient.
+ * @property {string} name The name of the listener to unregister.
+ */
+export interface UnregisterMessageListenerInput {
+    handleId: HandleId;
+    recipient: Recipient;
+    name: string;
+}
 /**
  * Messaging management for the Secure Communications Service.
  *
@@ -441,12 +469,26 @@ export interface MessagingModule {
      * @returns {PollResponses} The tallied responses for the poll.
      */
     getPollResponses(input: GetPollResponsesInput): Promise<PollResponses>;
+    /**
+     * Registers a message listener.
+     *
+     * @param {RegisterMessageListenerInput} input Parameters used to register a message listener.
+     */
+    registerMessageListener(input: RegisterMessageListenerInput): Promise<void>;
+    /**
+     * Unregisters a message listener.
+     *
+     * @param {UnregisterMessageListenerInput} input Parameters used to unregister a message listener.
+     */
+    unregisterMessageListener(input: UnregisterMessageListenerInput): Promise<void>;
 }
 export declare class DefaultMessagingModule implements MessagingModule {
     private readonly sessionManager;
     private readonly mediaCredentialManager;
     private readonly secureCommsServiceConfig;
     private readonly log;
+    private messageListeners;
+    private matrixEventListeners;
     constructor(sessionManager: SessionManager, mediaCredentialManager: MediaCredentialManager, secureCommsServiceConfig: SecureCommsServiceConfig);
     getMessages(input: GetMessagesInput): Promise<ListOutput<Message>>;
     getMessage(input: GetMessageInput): Promise<Message | undefined>;
@@ -467,4 +509,7 @@ export declare class DefaultMessagingModule implements MessagingModule {
     editPoll(input: EditPollInput): Promise<void>;
     endPoll(input: EndPollInput): Promise<void>;
     getPollResponses(input: GetPollResponsesInput): Promise<PollResponses>;
+    registerMessageListener(input: RegisterMessageListenerInput): Promise<void>;
+    unregisterMessageListener(input: UnregisterMessageListenerInput): Promise<void>;
+    private getHandleMessageListener;
 }