PinnedMessageListQuery

@objc(SBDPinnedMessageListQuery)
public final class PinnedMessageListQuery : NSObject, Queryable

This class provides a way to retrieve a list of pinned messages in a group channel. It has properties to get the query options and to check the status of the query.

Since

4.8.0

  • Indicates whether there are more pinned messages to retrieve.

    Declaration

    Swift

    @Atomic
@objc
public internal(set) var hasNext: Bool { get set }

  • Indicates whether the query is currently loading pinned messages.

    Declaration

    Swift

    @Atomic
@objc
public internal(set) var isLoading: Bool { get set }

  • The number of pinned messages to retrieve.

    Declaration

    Swift

    @objc
public let limit: Int

  • A boolean flag that determines whether or not to include a meta array in the message. The default value is false.

    Declaration

    Swift

    @objc
public var includeMetaArray: Bool { get }

  • A boolean flag that determines whether or not to include thread information in the message. The default value is false.

    Declaration

    Swift

    @objc
public var includeThreadInfo: Bool { get }

  • A boolean flag that determines whether or not to include reactions in the message. The default value is false.

    Declaration

    Swift

    @objc
public var includeReactions: Bool { get }

  • Determines whether a message includes the poll details or not. The default value is false.

    Declaration

    Swift

    @objc
public var includePollDetails: Bool { get }

  • Determines wheter to include information on parent message. The default value is false.

    Since

    4.8.2

    Declaration

    Swift

    @objc
public var includeParentMessageInfo: Bool { get }

  • Undocumented

    Declaration

    Swift

    @objc
public func loadNextPage(completionHandler: @escaping PinnedMessageListHandler)

  • Copies this object

    Declaration

    Swift

    public func copy(with zone: NSZone? = nil) -> Any

    Parameters

    zone

    optional NSZone

    Return Value

    PublicGroupChannelListQuery instance