v4.2.0

Author: chohongm

CHANGELOG.md

@@ -1,6 +1,28 @@
 
 # Changelog
 
+## v4.2.0 (Dec 9, 2022)
+### **Features**
+### **Pinned Message :pushpin:**
+Pinned Message is released. You can now maintain a special set of messages (up to 10 per channel) that you want everyone in the channel to share. It can be anything from announcements, surveys, upcoming events, and any many more. Pin your messages and never miss them!
+Stay tuned for updates as we are rolling out more exciting features and see below for exact specifications:point_down:
+#### **Specification**
+- Pin when sending a message
+  - `UserMessageCreateParams.isPinnedMessage: boolean = false`
+  - `FileMessageCreateParams.isPinnedMessage: boolean = false`
+- Pin existing message
+  - `GroupChannel.pinMessage(messageId: number): Promise<void>`
+- Unpin a message
+  - `GroupChannel.unpinMessage(messageId: number): Promise<void>`
+- Pinned messages
+  - `GroupChannel.lastPinnedMessage: BaseMessage = null`
+  - `GroupChannel.pinnedMessageIds: number[] = []`
+#### **We strongly recommend using Collections (Message, Channel) to implement Pinned Messages as it would automatically take care of numerous events out of the box when messages are created, updated, and deleted.**
+
+------
+### **Improvements**
+- Improved stability
+
 ## v4.1.5 (Nov 24, 2022)
 - `MessageCollection` now loads unsent messages from cache before `onCacheResult()` is called
 

__bundle-069d83a3.js

@@ -19,11 +19,13 @@ declare class AppInfo {
   readonly applicationAttributes: string[];
   readonly premiumFeatureList: string[];
   readonly enabledChannelMemberShipHistory: boolean;
+  static payloadify(appInfo: AppInfo): AppInfoParams;
 }
 
 export declare class AppleCriticalAlertOptions {
   readonly name: string;
   readonly volume: number;
+  serialize(): AppleCriticalAlertOptionsPayload;
 }
 
 export declare class ApplicationUserListQuery extends BaseListQuery {
@@ -178,6 +180,7 @@ declare interface BaseMessageCreateParams {
   isReplyToChannel?: boolean;
   pushNotificationDeliveryOption?: PushNotificationDeliveryOption;
   appleCriticalAlertOptions?: AppleCriticalAlertOptions;
+  isPinnedMessage?: boolean;
 }
 
 declare interface BaseMessageUpdateParams {
@@ -378,6 +381,8 @@ export declare class GroupChannel extends BaseChannel {
   inviter: User;
   invitedAt: number;
   joinedAt: number;
+  pinnedMessageIds: number[];
+  lastPinnedMessage: BaseMessage;
   get isHidden(): boolean;
   get isTyping(): boolean;
   get cachedUnreadMemberState(): object;
@@ -387,7 +392,7 @@ export declare class GroupChannel extends BaseChannel {
   createMessageCollection(params?: MessageCollectionParams): MessageCollection;
   createMemberListQuery(params?: MemberListQueryParams): MemberListQuery;
   addMember(member: Member, ts?: number): void;
-  removeMember(member: Member): boolean;
+  removeMember(memberOrUserId: Member | string): boolean;
   getUnreadMemberCount(message: BaseMessage): number;
   getUndeliveredMemberCount(message: BaseMessage): number;
   getReadMembers(message: BaseMessage, includeAllMembers?: boolean): Member[];
@@ -446,6 +451,8 @@ export declare class GroupChannel extends BaseChannel {
   getPollChangeLogsSinceToken(token: string): Promise<PollChangelogs>;
   createPollListQuery(limit?: number): PollListQuery;
   createPollVoterListQuery(pollId: number, pollOptionId: number, limit?: number): PollVoterListQuery;
+  pinMessage(messageId: number): Promise<void>;
+  unpinMessage(messageId: number): Promise<void>;
 }
 
 export declare class GroupChannelEventContext {
@@ -477,6 +484,7 @@ export declare enum GroupChannelEventSource {
   EVENT_MESSAGE_SENT = 'EVENT_MESSAGE_SENT',
   EVENT_MESSAGE_RECEIVED = 'EVENT_MESSAGE_RECEIVED',
   EVENT_MESSAGE_UPDATED = 'EVENT_MESSAGE_UPDATED',
+  EVENT_PINNED_MESSAGE_UPDATED = 'EVENT_PINNED_MESSAGE_UPDATED',
   REQUEST_CHANNEL = 'REQUEST_CHANNEL',
   REQUEST_CHANNEL_CHANGELOGS = 'REQUEST_CHANNEL_CHANGELOGS',
   SYNC_CHANNEL_BACKGROUND = 'SYNC_CHANNEL_BACKGROUND',
@@ -880,6 +888,8 @@ export declare class OpenChannel extends BaseChannel {
     customType: string,
   ): Promise<OpenChannel>;
   delete(): Promise<void>;
+  sendUserMessage(params: UserMessageCreateParams): MessageRequestHandler;
+  sendFileMessage(params: FileMessageCreateParams): MessageRequestHandler;
 }
 
 export declare interface OpenChannelUpdateParams {
@@ -1604,6 +1614,7 @@ declare abstract class GroupChannelHandlerParams extends BaseChannelHandlerParam
   onPollUpdated?: (channel: GroupChannel, event: PollUpdateEvent) => void;
   onPollVoted?: (channel: GroupChannel, event: PollVoteEvent) => void;
   onPollDeleted?: (channel: GroupChannel, id: number) => void;
+  onPinnedMessageUpdated?: (channel: GroupChannel) => void;
 }
 
 export declare enum GroupChannelListOrder {