update providers main api

docfiles/providers/interface/providers_system.js

@@ -4,7 +4,46 @@
  * @namespace ProvidersSystem
  */
 function ProvidersSystem() {
+
     /**
+     * Производит сброс всех провайдеров, на которые не ведет ни одна ссылка.
+     *
+     * Назначение: проверка корректности работы провайдеров и специфичная работа некоторых виджетов.
+     *
+     * Пример:
+     * есть виджеты в которых, осуществляется подписка на паблишер, но она существует только в рамках одного виджета,
+     * или одного поиска. Дальше грид не нужен и должен быть удален. (Алармы, Поиски)
+     *
+     * @example
+     * ps.drop_cache()
+     *
+     * @public
+     * @function drop_cache
+     * @memberof ProvidersSystem
+     */
+    this.drop_cache = function () {
+
+    };
+
+    /**
+     * Производит разрыв соединения между сервером и клиентом.
+     * В зависимости от настроек конфига, будет совершено переподключение.
+     *
+     * Назначение: проверка заморозки и восстановления состояния провайдеров
+     *
+     * @example
+     * ps.break_connection()
+     *
+     * @public
+     * @function break_connection
+     * @memberof ProvidersSystem
+     */
+    this.break_connection = function () {
+
+    };
+
+    /**
+     * Запускает работу провайдеров.
      *
      * @public
      * @function start
@@ -15,28 +54,62 @@ function ProvidersSystem() {
     };
 
     /**
+     * Опасный метод.
+     *
+     * Залогинится как рутовый пользователь. (При условии что name=root and password=root создан на сервере)
      *
      * @public
-     * @function login
+     * @function sign_as_root
      * @memberof ProvidersSystem
-     * @param _login {string}
-     * @param _password {string}
-     * @param _callback {function}
      */
-    this.login = function (_login, _password, _callback) {
+    this.sign_as_root = function () {
 
     };
 
     /**
+     * Произвести авторизацию в системе по имени пользователя
+     *
+     * @example
+     * ps.auth_by_password("user", "password")
+     * // Важно! При успешной авторизации идентификатор сессии записывается в куку.
+     * // Доступ к куке осущеставляется таким образом
+     * var tools = require("providers/tools/lib")
+     * tools.storage.session.get()
      *
      * @public
-     * @function break_connection
+     * @param {string} _login Имя пользователя
+     * @param {string} _password Пароль пользователя
+     * @param {function} _callback Вызовется когда придет результат авторизации
+     * @function auth_by_password
      * @memberof ProvidersSystem
      */
-    this.break_connection = function () {
+    this.auth_by_password = function (_login, _password, _callback) {
 
     };
 
+    /**
+     * Произвести авторизацию в системе по идентификатору сессии
+     *
+     * @example
+     * var tools = require("providers/tools/lib")
+     * var session = tools.storage.session.get();
+     * if(session != null){
+     *     ps.auth_by_session_id(session, function(_ev){
+     *         console.log(_ev)
+     *     });
+     * }
+     *
+     * @public
+     * @function auth_by_session_id
+     * @param {string} _session_id Идентификатор сессии
+     * @param {function} _callback Вызовется когда придет результат авторизации
+     * @memberof ProvidersSystem
+     */
+    this.auth_by_session_id = function (_session_id, _callback) {
+
+    };
+
+
     /**
      *
      * @name s_connected