Метод Navigator: registerProtocolHandler()

Метод Navigator позволяет веб-сайтам регистрировать возможность открытия или обработки определённых схем URL (также называемых протоколами).

Например, этот API позволяет веб-почте открывать mailto: URL-адреса, а VoIP-сайтам — tel: URL-адреса.

Для регистрации обработчика протокола веб-сайт вызывает registerProtocolHandler(), передавая в него регистрируемый протокол и шаблон URL.

При активации ссылки, использующей зарегистрированный протокол, браузер вставит href из активированной ссылки в шаблон URL, предоставленный во время регистрации обработчика, и перенаправит текущую страницу на полученный URL.

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

scheme

Строка, содержащая схему протокола, который сайт хочет обрабатывать.

Это может быть пользовательская схема, в этом случае имя схемы:

• Начинается с web+
• Содержит по крайней мере одну букву после префикса web+
• Содержит только строчные буквы ASCII.

В противном случае схема должна быть одной из следующих:

• bitcoin
• ftp
• ftps
• geo
• im
• irc
• ircs
• magnet
• mailto
• matrix
• mms
• news
• nntp
• openpgp4fpr
• sftp
• sip
• sms
• smsto
• ssh
• tel
• urn
• webcal
• wtai
• xmpp

url

Строка, содержащая URL обработчика. Этот URL должен включать %s, как заполнитель, который будет заменён на экранированный URL для обработки.

URL обработчика должен использовать схему https и иметь тот же происхождение, что и веб-страница, которая пытается зарегистрировать обработчик.

None (undefined).

SecurityError DOMException

Регистрация заблокирована браузером. Это может произойти, если:

• Зарегистрированная схема (протокол) некорректна, например, схема, которая сама обрабатывается браузером (https:, about:, и т.д.)
• Происхождение URL обработчика не соответствует происхождению страницы, вызывающей этот API.
• Схема URL обработчика не https.

SyntaxError DOMException

Отсутствует заполнитель %s в URL обработчика.

Веб-страницы часто содержат ссылки на ресурсы с использованием не-https протоколов. Примером является протокол mailto:. Авторы веб-страниц могут использовать mailto ссылку, когда им нужно предоставить удобный способ отправки электронного письма напрямую с веб-страницы:

<a href="mailto:webmaster@example.com">Web Master</a>

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

Веб-обработчики протоколов позволяют веб-приложениям также участвовать в этом процессе. Веб-приложение электронной почты по адресу mail.example.org может зарегистрировать обработчик mailto с помощью такого кода:

navigator.registerProtocolHandler("mailto", "https://mail.example.org/?to=%s");

После этого, когда пользователь щелкнет по mailto ссылке на любом сайте, браузер (возможно, после запроса подтверждения) перейдёт на https://mail.example.org/?to=mailto:webmaster@example.com. Эта страница может проанализировать параметр URL для извлечения адреса и использовать его для инициализации электронной почты.

В этом примере страница регистрирует обработчик для протокола web+burger с помощью такого кода:

navigator.registerProtocolHandler(
  "web+burger",
  "https://burgers.example.org/?burger=%s",
);

Впоследствии пользователь посещает страницу, содержащую ссылку:

<a href="web+burger:cheeseburger">cheeseburger</a>

Если пользователь активирует ссылку web+burger, браузер перейдёт (возможно, после запроса подтверждения) на https://burgers.example.org/?burger=web+burger:cheeseburger.