Class isp api::Session
Иерархия: | API -> C++ API -> Autogenerate |
API -> C++ API -> Autogenerate -> Классы |
Класс isp_api::Session
Пользовательская сессия
#include <action.h>
Описание:
class isp_api::Session
Данный класс - основной класс с которым работает программист для формирования ответа панели на запрос
See also: | mgr_session::BaseSession |
Родители:
Содержание
- 1 Открытые аттрибуты (кратко)
- 2 Открытые члены (кратко)
- 3 Приватные члены (кратко)
- 4 Методы
- 4.1 virtual string Param ( const string ¶m )
- 4.2 string OldValue ( const string ¶m )
- 4.3 string Param ( const string ¶m , T vld )
- 4.4 virtual void DelParam ( const string ¶m )
- 4.5 virtual void GetParams ( StringVector &res )
- 4.6 virtual bool Has ( const string ¶m )
- 4.7 size_t ProgressAddSteps ( int num = 1 )
- 4.8 size_t ProgressAddDone ( int num = 1 )
- 4.9 size_t ProgressAddFile ( const string &path , int64_t size , int num = 1 , const string &message = "" )
- 4.10 size_t ProgressAddRestart ( int num = 1 , const string &message = "restart" )
- 4.11 void ProgressSetComment ( const string &msgid , const string ¶m = "" )
- 4.12 string GetManagerUrl ()
- 4.13 virtual int GetRecordLimit ()
- 5 Данные
Открытые аттрибуты (кратко)
const BaseConnection & | conn
Текущее соединение |
const Authen & | auth
Информация о текущем пользователе |
const Action & | action
Информация о текщем действии |
Открытые члены (кратко)
size_t | ProgressAddFile ( const string &path , int64_t size , int num = 1 , const string &message = "" )
Увеличить количество пройденных шагов |
size_t | ProgressAddRestart ( int num = 1 , const string &message = "restart" )
Увеличить количество пройденых шагов |
void | ProgressSetComment ( const string &msgid , const string ¶m = "" )
Добавить текстовое сообщение |
string | GetManagerUrl ()
Возвращает URL использованный при обращении к панели |
virtual int | GetRecordLimit ()
Получить лимит количества записей в списке |
Методы работы с параметрами
virtual string | Param ( const string ¶m )
Вернуть значение параметра |
string | OldValue ( const string ¶m )
Вернуть "старое" значение параметра |
template <typename T>
string |
Param ( const string ¶m , T vld )
Вернуть значение параметра предварительно проверив его |
virtual void | DelParam ( const string ¶m )
Удалить параметр |
virtual void | GetParams ( StringVector &res )
Получить список имен параметров |
virtual bool | Has ( const string ¶m )
Проверить наличие параметра |
Методы для работы с индикатором выполнения (progressbar)
size_t | ProgressAddSteps ( int num = 1 )
Увеличить общее количество шагов |
size_t | ProgressAddDone ( int num = 1 )
Увеличить количество пройденных шагов |
Группа методов для работы с советами (tips)
WantTip возвращает true, если пользователь еще не видел подсказку, метод ShowTips() вернул true еще небыло добавлено ни одной подсказки ShowTips() возвращает true, если выполняется ряд условий: это запрос с output типа html, подсказки не отключены NewTip - добавляет в xml подсказку DropTip - помечает подсказку как просмотренную
Приватные члены (кратко)
Методы
virtual string Param ( const string ¶m )
Вернуть значение параметра
Аргументы: | |
[in] - | param Имя параметра |
Returned: | Возвращает строку, содержащую значение параметра с заданным именем или пустую строку если параметр с таким именем не существует |
string OldValue ( const string ¶m )
Вернуть "старое" значение параметра
Данный метод позволяет получить значение, которое было в поле формы на момент ее открытия, без учета параметров переданных при обращении к функции
Аргументы: | |
[in] - | param Имя параметра |
Returned: | Возвращает строку, содержащее предыдущее значение параметра с заданным именем или пустую строку |
string Param ( const string ¶m , T vld )
Данная функция/метод является inline функцией
Вернуть значение параметра предварительно проверив его
Аргументы: | |
[in] - | param Имя параметра |
[in] - | vld Валидатор. Валидатором может являться функтор или функция с сигнатурой test::Valid |
Returned: | В случае успешной проверки возвращает значение параметра, в противном случае - вызывает исключение типа mgr_err::Value |
See also: | Param |
virtual void DelParam ( const string ¶m )
Удалить параметр
После вызова DelParam имя параметра не будет возвращаться методом GetParams, и метод Has будет возвращать false.
virtual void GetParams ( StringVector &res )
Получить список имен параметров
virtual bool Has ( const string ¶m )
Проверить наличие параметра
Аргументы: | |
[in] - | param Имя параметра |
Returned: | Возвращает true, если параметр с заданным именем существует, в противном случае - false |
size_t ProgressAddSteps ( int num = 1 )
Увеличить общее количество шагов
Аргументы: | |
[in] - | num Количество шагов |
Returned: | Возвращает сумму шагов до вызова функции плюс переданное значение num |
size_t ProgressAddDone ( int num = 1 )
Увеличить количество пройденных шагов
Добавить к количеству пройденных шагов заданное значение. Когда суммарное значение пройденных шагов станет больше или равно значению, сформированному методом ProgressAddSteps(), то индикатор закроется в графическом интерфейсе. Вызов ProgressNextStep() аналогичен последовательному вызову ProgressAddDone() и ProgressSetComment()
Аргументы: | |
[in] - | num Количество шагов |
Returned: | Возвращает сумму пройденных шагов до вызова функции плюс переданное значение num |
size_t ProgressAddFile ( const string &path , int64_t size , int num = 1 , const string &message = "" )
Увеличить количество пройденных шагов
Нужно для закачки файла. Когда приходит запрос от progress смотрится размер файла в path, и высчитывается процент скачивания как отношение текущего размера к заданному size
Аргументы: | |
[in] - | path Путь до скачиваемого файла |
[in] - | size Размер скачиваемого файла |
[in] - | num Количество шагов |
Returned: | Возвращает сумму шагов до вызова функции плюс переданное значение num |
size_t ProgressAddRestart ( int num = 1 , const string &message = "restart" )
Увеличить количество пройденых шагов
Количество пройденых шагов будет увеличено после перезапуска панели
Аргументы: | |
[in] - | num Количество шагов |
Returned: | Возвращает сумму шагов до вызова функции плюс переданное значение num |
void ProgressSetComment ( const string &msgid , const string ¶m = "" )
Добавить текстовое сообщение
Если в текст индикатора необходимо подставить какое-либо значение, то в тексе необходимо указать последовательность param которая будет заменена на значение параметра param
Аргументы: | |
[in] - | msgid Идентификатор сообщения, которое будет отображено в качестве текста индикатора |
[in] - | param Значение параметра |
string GetManagerUrl ()
Возвращает URL использованный при обращении к панели
Warning: | Если текущий запрос был выполнен с помощью mgrctl, то будет отдан пустой результат |
Returned: | Возвращает строку с URL текущего менеджера |
virtual int GetRecordLimit ()
Получить лимит количества записей в списке
Данные
const BaseConnection &conn
Текущее соединение
See also: | mgr_session::BaseSession |
const Authen &auth
Информация о текущем пользователе
See also: | isp_api::Authen |
const Action &action
Информация о текщем действии
See also: | isp_api::Action |