sailplay-hub-actions

SAILPLAY.HUB.ACTIONS

Описание

SAILPLAY.HUB.ACTIONS расширяет стандартный функционал SAILPLAY.HUB, позволяя быстро и удобно работать с действиями SailPlay

Установка

Если вы используете npm:

npm install sailplay-hub-actions --save

SAILPLAY.HUB.ACTIONS требует для работы сам хаб, поэтому необходимо добавить на страницу теги:

<script src="путь до файла sailplay.hub.js"></script>
<script src="путь до файла sailplay.hub.actions.js"></script>

Принцип работы

В первую очередь, необходимо запустить хаб для вашей компании:

    SAILPLAY.send('init', { partner_id: 206 }); //инициируем модуль для партнера с айди = 206

Плагин добавляет в хаб следущие события:

##actions.parse

   SAILPLAY.send('actions.parse', actions); //Находит все элементы в документе, 
   //которые помечены атрибутом "data-sp-action" и добавляет к ним функционал действий, 
   //переданных в качестве второго параметра

Пример html кода действия для парсинга

    <div data-sp-action="action._actionId"></div>
    

Где:

• атрибут data-sp-action - уникальный идентификатор действия.

actions.perform

   SAILPLAY.send('actions.perform', action); //Инициирует выполнение действия, переданного в качестве второго параметра.

После выполнения действия инициируются следущие события:

actions.perform.success - действие выполнено успешно

actions.perform.error - при выполнении действия произошла ошибка

actions.perform.complete - статус действия обновился, необходимо обновить список

actions.social.connect.complete - статус привязки аккаунта изменился, необходимо обновить список

Все события возвращают объект, содержащий ответы сервера.

Так же плагин расширяет глобальный объект SAILPLAY свойством actions

Пример испозьзования SAILPLAY.actions

    SAILPLAY.on('actions.perform.error', function(err){
          sp_app.log(JSON.stringify(err));
        });
    
        SAILPLAY.on('actions.perform.success', function(action){
          SAILPLAY.send('load.actions.list');
          sp_app.log(JSON.stringify(action));
        });
    
        //после выполнения действия необходимо перезагрузить список
        SAILPLAY.on('actions.perform.complete', function(action){
          SAILPLAY.send('load.actions.list');
          sp_app.log(JSON.stringify(action));
        });
    
        //после привязки аккаунта необходимо перезагрузить список действий
        SAILPLAY.on('actions.social.connect.complete', function(action){
          SAILPLAY.send('load.actions.list');
          sp_app.log(JSON.stringify(action));
        });
    
        SAILPLAY.on('actions.social.connect.success', function(action){
          SAILPLAY.send('load.actions.list');
          sp_app.log(JSON.stringify(action));
        });
        

Пример можно посмотреть тут:

http://saike.ru/sailplay/widgets/demo/dev/

Исходный код страницы находится в данном репозитарии в директории: /demo/dev/