ScheduledBaseMessageCreateParams

public class ScheduledBaseMessageCreateParams: NSObject, Codable

A base class to create a scheduled message.

Since

4.0.0

  • The time to send the message, in Unix milliseconds format. Term between current time and scheduledAt should be more than 5 minutes.

    Since

    4.0.0

    Declaration

    Swift

    public var scheduledAt: Int64

  • The message data. The default value is nil.

    Since

    4.0.0

    Declaration

    Swift

    public var data: String?

  • The custom type of the message. The default value is nil.

    Since

    4.0.0

    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.

    Since

    4.0.0

    Declaration

    Swift

    public var pushNotificationDeliveryOption: PushNotificationDeliveryOption = .default

  • The meta arrays with keys and values

    Since

    4.0.0

    Declaration

    Swift

    public var metaArrays: [MessageMetaArray]?

  • The mention type that represents target type of mention.

    Since

    4.0.0

    Declaration

    Swift

    public var mentionType: MentionType = .users

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

    Since

    4.0.0

    Declaration

    Swift

    public var mentionedUserIds: [String]?

  • Mention to specific users with user objects.

    Since

    4.0.2

    Declaration

    Swift

    public var mentionedUsers: [User]?

  • Adds user IDs for mention

    Since

    4.0.0

    Declaration

    Swift

    public func addMentionedUserIds(_ userIds: [String])

    Parameters

    userIds

    list of user IDs

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

    Since

    4.0.0

    Declaration

    Swift

    public var appleCriticalAlertOptions: AppleCriticalAlertOptions?

  • Undocumented

    Declaration

    Swift

    public init(scheduledAt: Int64)

  • Declaration

    Swift

    public func encode(to encoder: Encoder) throws

  • Declaration

    Swift

    public required init(from decoder: Decoder) throws