NotificationInfo

@Serializable
data class NotificationInfo(val notifyAt: NotificationType, val offset: String? = null, val interval: String? = null, val allowSnooze: Boolean? = null, val message: NotificationMessage? = null, val type: String? = null)

A notification to show to a participant as part of the execution of a scheduled session.

Parameters

notifyAt
offset

The time after a window starts or before it ends (based on the notifyAt property) when a notification should be shown to the user.

interval

If a window lasts for more thatn twenty-four hours, a notification can be repeated on a daily repeat value. Only day values are allowed.

allowSnooze

Allow the participant to “snooze” a notification or reminder (dismiss it with some amount of time before it occurs again). Cannot be true if notifyAt is null.

message
type

NotificationInfo

Constructors

Link copied to clipboard
constructor(notifyAt: NotificationType, offset: String? = null, interval: String? = null, allowSnooze: Boolean? = null, message: NotificationMessage? = null, type: String? = null)

Properties

Link copied to clipboard
@SerialName(value = "allowSnooze")
val allowSnooze: Boolean? = null
Link copied to clipboard
@SerialName(value = "interval")
val interval: String? = null
Link copied to clipboard
@SerialName(value = "message")
val message: NotificationMessage? = null
Link copied to clipboard
@SerialName(value = "notifyAt")
val notifyAt: NotificationType
Link copied to clipboard
@SerialName(value = "offset")
val offset: String? = null
Link copied to clipboard
@SerialName(value = "type")
val type: String? = null