MessageRetrievalParams

@objc(SBDMessageRetrievalParams)
public class MessageRetrievalParams : NSObject, NSCopying

An object contains set of options to retrieve a message.

Since

3.0.181
  • Specifies the URL of the channel to retrieve the message.

    Declaration

    Swift

    @objc
    public var channelURL: String
  • Specifies the type of the channel.

    Declaration

    Swift

    @objc
    public var channelType: ChannelType
  • Specifies the unique ID of the message to retrieve.

    Declaration

    Swift

    @objc
    public var messageId: Int64
  • Determines whether the metaarray of the message is included in the results.

    Declaration

    Swift

    @objc
    public var includeMetaArray: Bool
  • Determines wheter to include reactions in the results. Default is false

    Since

    3.0.237

    Declaration

    Swift

    @objc
    public var includeReactions: Bool
  • Determines whether to include the thread information of the message when it is a parent message. Default is false

    Declaration

    Swift

    @objc
    public var includeThreadInfo: Bool
  • Determines wheter to include information on parent message. Default is false

    Since

    3.0.236

    Declaration

    Swift

    @objc
    public var includeParentMessageInfo: Bool
  • Default constructor.

    Declaration

    Swift

    public override init()
  • Parameter constructor

    Declaration

    Swift

    @objc
    public init(
        channelURL: String = "",
        channelType: ChannelType = .group,
        messageId: Int64 = 0,
        includeMetaArray: Bool = false,
        includeReactions: Bool = false,
        includeThreadInfo: Bool = false,
        includeParentMessageInfo: Bool = false
    )
  • Copies this object

    Declaration

    Swift

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

    Parameters

    zone

    optional NSZone

    Return Value

    MessageRetrievalParams instance