Форум

Методология

Инструментарий

Платформа

Сообщество

desktop
touch-pad
touch-phone

idle

Блок предоставляет объект, содержащий набор методов для генерации события в момент прекращения пользовательской активности (т.е. пользователь работает с другим окном или не совершает действий).

Обзор

События объекта

Доступен следующий набор событий:

Имя Описание
idle Браузер простаивает.
wakeup Пользователь возобновил активность.

Свойства и методы объекта

Имя Возвращаемое значение Описание
start() - Запуск отслеживания пользовательской активности.
stop() - Остановка отслеживания пользовательской активности.
isIdle() Boolean Проверка текущего состояния.

Модификаторы блока

Модификатор Допустимые значения Способы использования Описание
start auto JS Автоматический запуск отслеживания пользовательской активности.

Публичные технологии блока

Блок реализован в технологиях:

  • js

Описание

Подписавшись на события блока можно приостанавливать выполнение операций, например, отображение анимации, при отсутствии пользовательской активности.

Блок наследуется от класса Emitter блока events, что позволяет вызывать его методы.

modules.require(['idle'], function(idle) {

idle
    .on({
        idle : function() {
            // обработчик события idle
        },
        wakeup : function() {
            // обработчик события wakeup
        }
    })
    .start(); // запуск генерации событий

});

События объекта

Событие idle

Генерируется при прекращении пользовательской активности.

Событие wakeup

Генерируется в момент возобновления пользовательской активности.

Свойства и методы объекта

Метод start

Запуск отслеживания пользовательской активности.

Не принимает аргументов.

Не имеет возвращаемого значения.

modules.require(['idle'], function(idle) {

idle.start()

});

Метод stop

Служит для прекращения отслеживания пользовательской активности.

Не принимает аргументов.

Не имеет возвращаемого значения.

modules.require(['idle'], function(idle) {

idle.start() // начинаем отслеживать активность
idle.stop() // прекращаем отслеживать активность

});

Метод isIdle

Служит для проверки наличия пользовательской активности.

Не принимает аргументов.

Возвращаемое значение: Boolean. В случае если активность отсутствует – true.

modules.require(['idle'], function(idle) {

idle.isIdle() // true или false, в зависимости от текущего состояния

});

Модификаторы блока

Модификатор start

Допустимые значения: 'auto'.

Способ использования: подключается в файле зависимостей deps.js.

Автоматический запуск отслеживания пользовательской активности.

Instance methods:
start
stop
isIdle

Module idle

Instance methods:

start()
description
Starts monitoring of idle state
stop()
description
Stops monitoring of idle state
isIdle():Boolean
description
Returns whether state is idle