APISetUserState
|
APISetUserState |
|
Эта функция используется для изменения состояния клиента.
Ret = APISetUserState(UserID, Cash, NewState, AdminName, AdminNote)
Аргументы
UserID
Строковое выражение, определяющее идентификатор клиента - GUID или отображаемое имя клиента.
Cash
Сумма оплаты - числовое значение задающее значение поля Оплачено. Отметим, что это значение к существующему не добавляется, а переписывает имеющееся. Имеет смысл только для клиента.
NewState
Числовое значение задающее новое состояние сессии клиента:
0 |
СТОП. |
1 |
ПАУЗА. |
2 |
РАБОТА. |
Любые другие значения к изменению состояния сессии не приведут.
AdminName
Строковое выражение определяющее имя администратора, заносится в файл журнала при выполнении этой операции.
AdminNote
Строковое выражение определяющее примечание, также заносимое в файл журнала.
Замечания
Запись в журнал производится, если вызов этой функции привел к изменению каких-либо параметров клиента.
Эта функция совместно с функцией APISetBillProp может использоваться для различных действий, связанных с тарификацией. Так как они позволяют манипулировать только с одним клиентом, то для групповых операций надо применять циклы. Для получения списков пользователей и групп используйте функцию APIGetBillProp.
Возвращаемое значение
Функция возвращает true, если какие-либо параметры были изменены.
Пример использования
См. скрипты Добавление оплаты для группы клиентов, Рестарт сессии с переносом остатков.
Текущая страница справки: help.smart-soft.ru/index.html?apisetuserstate.htm