Timer

// Starts the timer for 1 minute, will return started Timer instance or throw an error.
const timer = await miro.board.timer.start(60 * 1000);

console.log(timer) // TimerInstance { restDuration: 60000, status: 'STARTED', totalDuration: 60000 }

// Gets the current state of timer.
const timer = await miro.board.timer.get();

console.log(timer) // TimerInstance { restDuration: 9000, status: 'STARTED', totalDuration: 60000 }

// Stops the timer, this async method will return instance of timer after stopping if operation was successful or throw error if not.
const isSuccessful = await miro.board.timer.stop();

// Pauses the timer, this async method will return instance of timer after pause if operation was successful or throw error if not.
const isSuccessful = await miro.board.timer.pause();

// Resumes the timer, this async method will return instance of timer after resuming if operation was successful or throw error if not.
const isSuccessful = await miro.board.timer.resume();

// Prolongs the timer by 1 minute, will return instance of timer after prolonging if operation was successful or throw error if not.
const timer = await miro.board.timer.prolong(60 * 1000);

// Checks if the timer is started or no, this async method will return boolean value.
const isTimerStarted = await miro.board.timer.isStarted();

/** When a user starts a timer:
 *  1. 'start' logs the timer properties.
 *  2. plays some random sound.
 */

// Listen to the 'start' event.
await miro.board.timer.on("start", async (event) => {
  console.log("Subscribed to the board timer start event =>", event);
  await playRandomSound();
});

/** When a user, for example, prolongs a timer:
 *  1. 'update' logs the timer properties.
 *  2. logic will show notification with rest duration of updated timer.
 */

// Listen to the 'update' event.
await miro.board.timer.on("update", async (event) => {
  console.log("Subscribed to the board timer start event =>", event);
  await miro.board.notifications.showInfo(
    `Rest duration: ${event.restDuration}`
  );
});

/** When the board timer is finished:
 *  1. 'finish' logs the timer properties.
 *  2. opens the feedback form in the modal.
 */

// Listen to the 'finish' event.
await miro.board.timer.on("finish", async (event) => {
  console.log("Subscribed to the board timer finish event =>", event);
  await miro.board.ui.openModal({ url: "/feedback-form" });
});

// Add an 'timerStart' event handler to log an started timer information.
const timerStart = async (event: TimerEvent) => {
  console.log(event);
};

// Register the 'start' event so that the app listens to it.
miro.board.timer.on('start', timerStart);

// Unsubscribe from the 'start' event handler.
// The app no longer enables logging timer information on start of it.
miro.board.timer.off('start', timerStart);

// Add a 'timerUpdate' event handler to log an updated timer information.
const timerUpdate = async (event: TimerEvent) => {
  console.log(event);
};

// Register the 'update' event so that the app listens to it.
miro.board.timer.on('update', timerUpdate);

// Unsubscribe from the 'update' event handler.
// The app no longer enables logging information about the updated timer.
miro.board.timer.off('update', timerUpdate);

// Add a 'timerFinish' event handler to log information about a finished timer.
const timerFinish = async (event: TimerEvent) => {
  console.log(event);
};

// Register the 'finish' event so that the app listens to it.
miro.board.timer.on('finish', timerFinish);

// Unsubscribe from the 'finish' event handler.
// The app no longer enables logging timer information on finish of this timer.
miro.board.timer.off('finish', timerFinish);