Package org.freeplane.api

Interface ReminderRO

  • All Known Subinterfaces:
    Proxy.Reminder, Proxy.ReminderRO, Reminder
    public interface ReminderRO
    Reminder: node.reminder - read-only. 
      def rem = node.reminder
  if (!rem.remindAt)
      c.statusInfo = "this node has no reminder"
  else
      c.statusInfo = "reminder fires at ${rem.remindAt} and then every ${rem.period} ${rem.periodUnit}"

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.Integer getPeriod()
      Count in units of "PeriodUnit".
      java.lang.String getPeriodUnit()
      One of ["MINUTE", "HOUR", "DAY", "WEEK", "MONTH", "YEAR"].
      java.util.Date getRemindAt()
      The timestamp when the reminder fires first.
      java.lang.String getScript()
      optional: a Groovy script to execute when the reminder fires.

    • Method Detail

      • getRemindAt

        java.util.Date getRemindAt()
        The timestamp when the reminder fires first.

      • getPeriodUnit

        java.lang.String getPeriodUnit()
        One of ["MINUTE", "HOUR", "DAY", "WEEK", "MONTH", "YEAR"].

      • getPeriod

        java.lang.Integer getPeriod()
        Count in units of "PeriodUnit". (period=2, periodUnit="WEEK") reminds every two weeks.

      • getScript

        java.lang.String getScript()
        optional: a Groovy script to execute when the reminder fires.