OnlinePBX SDK-frontend

Frontend-клиент OnlinePBX SDK библиотеки

Установка и использование

Библиотека устанавливается как обычная npm-зависимость через команду

npm install @onlinepbx/sdk-frontnend

Для использования библиотеки нужно импортировать виджет

import OnlinepbxSDKWidget from '@onlinepbx/sdk-frontend'

После этого инициализировать экземпляр класса и передать в него нужны параметры

const mySDKWidgetButton = new OnlinepbxSDKWidget({
    sdk_domain: SDK_DOMAIN,
    button_name: BUTTON_NAME,
    user_login: USER_LOGIN,
    user_password: USER_PASSWORD,
    title: 'Название компании',
})

Принимаемые параметры

Parameter	Required field		Type	Description
sdk_domain	required	string	Ваш SDK-домен
button_name	required	string	Имя кнопки
user_login	optional*	string	Логин пользователя
user_password	optional*	string	Пароль пользователя
title	required	string	Название компании
call_btn_text	optional	string	текст, отображаемый справа от кнопки звонка
call_btn_position	optional	string	позиционирование кнопки звонка, принимает css текст абсолютного позиционирования, например, 'top: 20px; right:20px;bottom:auto;left:auto;' - два противоположных занчения должны быть всегда auto
modal_position	optional	string	позиционирование модального окна звонка, принимает css текст абсолютного позиционирования, например, 'top:20px;right:20px;bottom:auto;left:auto;' - два противоположных занчения должны быть всегда auto
noRingtone	optional	boolean	отключить звук входящего на виджет звонка
autoconnect	optional	boolean	автоподключение и авторегистрация виджета при инициализации, обязательно нужно передавать логин и пароль
parent_node	optional	HTMLElement	HTMLBodyElement	родительский html-элемент, к которому будет прикрепляться виджет, по умолчают document.body
get_credentials	optional	() => Promise<{ login: string; password: string; }>	функция для получения логина и пароля перед регистрацией, если не передавать логин и пароль
on_click_call_btn	optional	(evt?: MouseEvent) => void	обработчик события нажатия на кнопку звонка
on_click_answer_btn	optional	(evt?: MouseEvent) => void	обработчик события нажатия на кнопку ответа на входящий звонок
on_click_decline_btn	optional	(evt?: MouseEvent) => void	обработчик события нажатия на кнопку отклонения/завершения звонка
on_click_mute_btn	optional	(evt?: MouseEvent) => void	обработчик события нажатия на кнопку отключения звука микрофона
on_click_unmute_btn	optional	(evt?: MouseEvent) => void	обработчик события нажатия на кнопку включения звука микрофона
on_click_minimise_btn	optional	(evt?: MouseEvent) => void	обработчик события нажатия на кнопку сворачивания модального окна звонка
on_click_expand_btn	optional	(evt?: MouseEvent) => void	обработчик события нажатия на кнопку разворачивания модального окна звонка

*Если не передавать user_login и user_password, то обязательно нужно передавать get_credentials - функцию, которая будет запрашивать логин и пароль