PinnedMessageListQueryParams

public final class PinnedMessageListQueryParams: NSObject, NSCopying

A class that provides options to fetch pinned messages from a server.

Since

4.8.0

  • The number of BaseMessages per queried page. Default is 50.

    Since

    4.8.0

    Declaration

    Swift

    public var limit: Int = 50

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

    Since

    4.8.0

    Declaration

    Swift

    public var includeMetaArray: Bool = false

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

    Since

    4.8.0

    Declaration

    Swift

    public var includeThreadInfo: Bool = false

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

    Since

    4.8.0

    Declaration

    Swift

    public var includeReactions: Bool = false

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

    Since

    4.8.0

    Declaration

    Swift

    public var includePollDetails: Bool = false

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

    Since

    4.8.2

    Declaration

    Swift

    public var includeParentMessageInfo: Bool = false

  • Default constructor.

    Declaration

    Swift

    public override init()

  • Initializes and returns a newly allocated params object that mutated through builder closure.

    Since

    4.8.0

    Declaration

    Swift

    public init(builder: (PinnedMessageListQueryParams) -> Void)

    Parameters

    builder

    The builder closure.

    Return Value

    An initialized params object.

  • Copies this object

    Declaration

    Swift

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

    Parameters

    zone

    optional NSZone

    Return Value

    PinnedMessageListQueryParams instance