Методы управления виджетом

В этом справочнике описаны все доступные методы JavaScript API Servicepipe Widget CAPTCHA.

Для обращения к конкретному виджету используйте его идентификатор из свойства widget.id. Если на странице только один виджет, методы, принимающие widgetId, можно вызывать без идентификатора.

Метод Что делает Когда использовать

Метод	Что делает	Когда использовать
`SPCaptcha.ready(callback)`	Дожидается готовности SDK и DOM, затем вызывает переданную функцию.	Когда код приложения подключён отдельным `defer`-скриптом после SDK.
`SPCaptcha.render(container, options)` Открыть список доступных опций	Создаёт капчу в указанном контейнере и возвращает объект виджета. В свойстве `widget.id` находится его идентификатор.	Когда капчу нужно разместить в определённом месте страницы.
`SPCaptcha.execute(options)` Открыть список доступных опций	Открывает капчу в модальном окне. Возвращает `Promise`, результатом которого после успешной проверки будет токен.	Когда проверку нужно запустить перед защищаемым действием без предварительного создания виджета.
`SPCaptcha.execute(widgetId)`	Запускает проверку для ранее созданного виджета.	Когда виджет уже создан через `SPCaptcha.render()`.
`SPCaptcha.getResponse(widgetId)`	Возвращает текущий токен. Если токен ещё не получен или уже истёк, возвращает пустую строку.	Когда токен нужно получить позднее, а не обрабатывать сразу через callback-функцию или событие `success`.
`SPCaptcha.reset(widgetId)`	Очищает токен и возвращает виджет в исходное состояние.	Когда пользователь начинает новое защищаемое действие, сбрасывает форму или проверку нужно запустить заново. После истечения срока действия токена SDK очищает его автоматически.
`SPCaptcha.destroy(widgetId)`	Удаляет содержимое, обработчики и таймеры виджета. Внешний контейнер остаётся на странице.	При удалении компонента, переходе между экранами SPA или полной замене виджета.

SPCaptcha.ready(callback)

Дожидается готовности SDK и DOM, затем вызывает переданную функцию.

Когда код приложения подключён отдельным defer-скриптом после SDK.

SPCaptcha.render(container, options)

Открыть список доступных опций

Создаёт капчу в указанном контейнере и возвращает объект виджета. В свойстве widget.id находится его идентификатор.

Когда капчу нужно разместить в определённом месте страницы.

SPCaptcha.execute(options)

Открыть список доступных опций

Открывает капчу в модальном окне. Возвращает Promise, результатом которого после успешной проверки будет токен.

Когда проверку нужно запустить перед защищаемым действием без предварительного создания виджета.

SPCaptcha.execute(widgetId)

Запускает проверку для ранее созданного виджета.

Когда виджет уже создан через SPCaptcha.render().

SPCaptcha.getResponse(widgetId)

Возвращает текущий токен. Если токен ещё не получен или уже истёк, возвращает пустую строку.

Когда токен нужно получить позднее, а не обрабатывать сразу через callback-функцию или событие success.

SPCaptcha.reset(widgetId)

Очищает токен и возвращает виджет в исходное состояние.

Когда пользователь начинает новое защищаемое действие, сбрасывает форму или проверку нужно запустить заново. После истечения срока действия токена SDK очищает его автоматически.

SPCaptcha.destroy(widgetId)

Удаляет содержимое, обработчики и таймеры виджета. Внешний контейнер остаётся на странице.

При удалении компонента, переходе между экранами SPA или полной замене виджета.