BaseMessageCreateParams

public class BaseMessageCreateParams: NSObject, Codable, NSCopying

Represents the base class which has parameters to create a channel.

The UserMessageCreateParams, the FileMessageCreateParams are derived from this class.

  • Message data. The default value is nil.

    Since

    3.0.90

    Declaration

    Swift

    public var data: String?

  • Customize message’s type to filter. The default value is nil.

    Since

    3.0.90

    Declaration

    Swift

    public var customType: String?

  • The push notification delivery option that determines how to deliver the push notification when sending a user or a file message. The default value is .default.

    Declaration

    Swift

    public var pushNotificationDeliveryOption: PushNotificationDeliveryOption

  • Meta array with keys and values

    Since

    3.0.179

    Declaration

    Swift

    public var metaArrays: [MessageMetaArray]?

  • Mention type

    Since

    3.0.103

    Declaration

    Swift

    public var mentionType: MentionType

  • Mention to specific users with user IDs. If sends a message with this field, the message will be arrived to mentioned users.

    Since

    3.0.90

    Declaration

    Swift

    public var mentionedUserIds: [String]?

  • Mention to specific users with user objects.

    Since

    4.0.0

    Declaration

    Swift

    public var mentionedUsers: [User]?

  • Adds user IDs for mention

    Declaration

    Swift

    public func addMentionedUserIds(_ userIds: [String])

    Parameters

    userIds

    list of user IDs

  • The unique ID of a parent message. The default value is 0.

    Since

    3.0.181

    Declaration

    Swift

    public var parentMessageId: Int64

  • Determines if a threaded message is also replied to the channel. Default is false

    Since

    3.0.236

    Declaration

    Swift

    public var isReplyToChannel: Bool

  • Push notification options for the Apple critical alert. The default value is nil.

    Since

    3.0.221

    Declaration

    Swift

    public var appleCriticalAlertOptions: AppleCriticalAlertOptions?

  • Custom payload

    Declaration

    Swift

    public var payload: [String: Any] = [:]

  • Determines if the sending message is also a pinned message. Default is false.

    Since

    4.2.0

    Declaration

    Swift

    public var isPinnedMessage: Bool = false

  • Default constructor.

    Declaration

    Swift

    public override init()

  • Copies this object

    Declaration

    Swift

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

    Parameters

    zone

    optional NSZone

    Return Value

    BaseMessageCreateParams instance

  • Encodes this object.

    Declaration

    Swift

    public func encode(to encoder: Encoder) throws

    Parameters

    encoder

    Encoder instance

  • Default constructor.

    Declaration

    Swift

    public required init(from decoder: Decoder) throws

    Parameters

    decoder

    Decoder instance