MessageRetrievalParams

public final 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

    public var channelURL: String = ""

  • Specifies the type of the channel.

    Declaration

    Swift

    public var channelType: ChannelType = .group

  • Specifies the unique ID of the message to retrieve.

    Declaration

    Swift

    public var messageId: Int64 = 0

  • Determines whether the metaarray of the message is included in the results.

    Declaration

    Swift

    public var includeMetaArray: Bool = false

  • Determines wheter to include reactions in the results. Default is false

    Since

    3.0.237

    Declaration

    Swift

    public var includeReactions: Bool = false

  • Determines whether to include the thread information of the message when it is a parent message. Default is false

    Declaration

    Swift

    public var includeThreadInfo: Bool = false

  • Determines wheter to include information on parent message. Default is false

    Since

    3.0.236

    Declaration

    Swift

    public var includeParentMessageInfo: Bool = false

  • Default constructor.

    Declaration

    Swift

    public override init()

  • Parameter constructor

    Declaration

    Swift

    @available(*, deprecated, renamed: "init(channelURL:channelType:messageId:builder:﹚")
public init(
    channelURL: String = "",
    channelType: ChannelType = .group,
    messageId: Int64 = 0,
    includeMetaArray: Bool = false,
    includeReactions: Bool = false,
    includeThreadInfo: Bool = false,
    includeParentMessageInfo: Bool = false
)

  • Parameter constructor

    Declaration

    Swift

    public init(
    channelURL: String,
    channelType: ChannelType,
    messageId: Int64,
    builder: ((MessageRetrievalParams) -> Void)? = nil
)

  • Copies this object

    Declaration

    Swift

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

    Parameters

    zone

    optional NSZone

    Return Value

    MessageRetrievalParams instance