Методы

new Spotlight(
	$id
)

Параметр:

• id - идентификатор подсказки.

Пример:

use \Bitrix\Main\UI\Spotlight;

$spotlight = new Spotlight("my-hint");
$spotlight->setEndDate(time() - 3600);
$spotlight->setLifetime(3600 * 5);
$spotlight->setUserTimeSpan(3600 * 5);
$spotlight->setUserType(Spotlight::USER_TYPE_NEW); //для новых пользователей
if ($spotlight->isAvailable())
{
	//можно показывать подсказку
}

spotlight.isAvailable(
	$userId = false
)

Параметры:

• userId {number} - Идентификатор пользователя.

spotlight.getActivationDate

spotlight.activate(
	$activationDate = false
)

Параметры:

• activationDate {number} - Дата активации подсказки на сайте в секундах (timestamp). По умолчанию текущее время.

spotlight.deactivate

spotlight.isViewed(
	$userId
)

Параметры:

• userId {number} - Идентификатор пользователя.

spotlight.getViewDate(
	$userId
)

Параметры:

• userId {number} - Идентификатор пользователя.

spotlight.setViewDate(
	$userId,
	$date = false
)

Параметры:

• userId {number} - Идентификатор пользователя.
• date {number} - Дата просмотра подсказки в секундах (timestamp). По умолчанию текущее время.

spotlight.unsetViewDate(
	$userId
)

Параметры:

• userId {number} - Идентификатор пользователя.

spotlight.getId

spotlight.getUserType

• NEW - новый пользователь.
• OLD - старый пользователь.
• ALL - любой пользователь.

spotlight.setUserType(
	$userType
)

Параметры:

• userType - Тип пользователя. Допустимые значения:
  • Spotlight::USER_TYPE_OLD - старый пользователь.
  • Spotlight::USER_TYPE_NEW - новый пользователь.
  • Spotlight::USER_TYPE_ALL - любой пользователь.

spotlight.setUserTimeSpan(
	$userTimeSpan
)

Параметры:

• userTimeSpan {number} - Промежуток времени в секундах.

spotlight.getUserTimeSpan

spotlight.getLifetime

spotlight.setLifetime(
	$lifetime
)

Параметры:

• lifetime {number} - Время жизни подсказки в секундах

spotlight.getStartDate

spotlight.setStartDate(
	$startDate
)

Параметры:

• startDate {number|null} - Дата, с которой начнется показ подсказки в секундах (timestamp).

spotlight.getEndDate

spotlight.setEndDate(
	$endDate
)

Параметры:

• endDate {number|null} - Дата, до которой возможен показ подсказки в секундах (timestamp).