AlarmCreateInfo constructor

AlarmCreateInfo({
  1. String? name,
  2. double? when,
  3. double? delayInMinutes,
  4. double? periodInMinutes,
  5. bool? persistAcrossSessions,
})

Implementation

AlarmCreateInfo({
  /// Name of this alarm.
  String? name,

  /// Time at which the alarm should fire, in milliseconds past the epoch
  /// (e.g. `Date.now() + n`).
  double? when,

  /// Length of time in minutes after which the `onAlarm` event
  /// should fire.
  ///
  /// <!-- TODO: need minimum=0 -->
  double? delayInMinutes,

  /// If set, the onAlarm event should fire every [periodInMinutes]
  /// minutes after the initial event specified by [when] or
  /// [delayInMinutes].  If not set, the alarm will only fire once.
  ///
  /// <!-- TODO: need minimum=0 -->
  double? periodInMinutes,

  /// Whether the alarm should persist across sessions (browser restarts). In
  /// Chrome, this defaults to true to match historical behavior, but you
  /// should
  /// set this explicitly to maximize compatibility across browsers.
  bool? persistAcrossSessions,
}) : _wrapped = $js.AlarmCreateInfo(
        name: name,
        when: when,
        delayInMinutes: delayInMinutes,
        periodInMinutes: periodInMinutes,
        persistAcrossSessions: persistAcrossSessions,
      );