feat(lib): deprecate old reporting methods

pubnub · Jul 31, 2024 · c6dda44 · c6dda44
1 parent 91bef3c
commit c6dda44
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 7 deletions.
diff --git a/lib/src/entities/channel.ts b/lib/src/entities/channel.ts
@@ -750,20 +750,20 @@ export class Channel {
   }
 
   /**
-   * Flagged messages
+   * Reported messages
    */
 
-  async getFlaggedMessagesHistory(
+  async getMessageReportsHistory(
     params: { startTimetoken?: string; endTimetoken?: string; count?: number } = {}
-  ) {
+  ): Promise<{ events: Event<"report">[]; isMore: boolean }> {
     const channel = `${INTERNAL_MODERATION_PREFIX}${this.id}`
     return this.chat.getEventsHistory({
       ...params,
       channel,
     })
   }
 
-  listenForFlaggedMessages(callback: (event: Event<"report">) => void) {
+  streamMessageReports(callback: (event: Event<"report">) => void) {
     const channel = `${INTERNAL_MODERATION_PREFIX}${this.id}`
     return this.chat.listenForEvents({
       channel,

diff --git a/lib/src/entities/message.ts b/lib/src/entities/message.ts
@@ -368,7 +368,8 @@ export class Message {
     await this.chat.pinMessageToChannel(this, channel!)
   }
 
-  async report(reason: string) {
+  /** @deprecated */
+  async DEPRECATED_report(reason: string) {
     const channel = INTERNAL_ADMIN_CHANNEL
     const payload = {
       text: this.text,
@@ -380,7 +381,7 @@ export class Message {
     return await this.chat.emitEvent({ channel, type: "report", payload })
   }
 
-  async reportOnChannel(reason: string) {
+  async report(reason: string) {
     const channel = `${INTERNAL_MODERATION_PREFIX}${this.channelId}`
     const payload = {
       text: this.text,

diff --git a/lib/src/entities/user.ts b/lib/src/entities/user.ts
@@ -218,7 +218,8 @@ export class User {
   /*
    * Other
    */
-  async report(reason: string) {
+  /** @deprecated */
+  async DEPRECATED_report(reason: string) {
     const channel = INTERNAL_ADMIN_CHANNEL
     const payload = {
       reason,