/ SDKs / iOS
SDKs
Chat SDKs iOS v4
Chat SDKs iOS
Chat SDKs
iOS
Version 4

Unpin a message

Copy link

Sendbird Chat SDK for iOS allows you to unpin messages in group channels. Unpinning messages that are no longer relevant or important helps to keep the pinned messages organized in your channel.


Unpinning a message in a channel

Copy link

You can unpin a message using the unpinMessage() method of the GroupChannel class. Specify the messageId to unpin as shown in the code below.

// The below code assumes that the `userMessage` was already pinned.

// Unpin a pinned message.
channel.unpinMessage(messageId: userMessage.messageId) { error in
    guard error == nil else {
        // Handle error.
        return
    }
    // The message has been successfully unpinned.
}

The following table shows a list of properties related to the pinned messages feature. The pinnedMessageIds, and lastPinnedMessage properties belong to the GroupChannel class.

List of properties

Copy link
Property nameTypeDescription

pinnedMessageIds

[Int64]?

Specifies an array of message IDs of the pinned messages in a group channel.

lastPinnedMessage

BaseMessage?

Specifies the last message that was pinned in a group channel.

Getting notified when a message is unpinned

Copy link

Once a message is unpinned, the channelDidUpdatePinnedMessages() event delegate is invoked. For further information on GroupChannelDelegate, see the Add or remove a channel delegate page.