Программный продукт «QP8.Framework» (стр. 27 )

Добавляет пользователя в указанную группу.

Метод AddUserToItemPermission

public void AddUserToItemPermission(int userId, int itemId, int permissionId)

Задаёт или изменяет права доступа для пользователя на указанную статью.

Метод AuthenticateUser

public int AuthenticateUser(string username, string password)

Производит попытку аутентификации пользователя. При успешной аутентификации возвращает идентификатор пользователя, при неуспешной – 0.

Параметры:

Название	Описание
username	Имя пользователя
password	Пароль пользователя

Метод CopyUsersFromGroupToGroup

public void CopyUsersFromGroupToGroup(int fromGroupId, int toGroupId)

Копирует пользователей из группы fromGroupId в группу toGroupId.

Внимание: копируются только отсутствующие в группе toGroupId пользователи.

Метод GetAllGroups

public DataTable GetAllGroups()

Возвращает все группы пользователей. Возвращаемые поля:

group_id, group_name, created, modified.

Метод GetAllGroupsForContentPermission

public DataTable GetAllGroupsForContentPermission(int contentId)

Возвращает данные по всем группам пользователей, для которых явно настроены права доступа на указанный контент. Возвращаемые поля:

group_id, group_name, created, modified.

Метод GetAllGroupsForItemPermission

public DataTable GetAllGroupsForItemPermission(int itemId)

Возвращает данные по всем группам пользователей, для которых явно настроены права доступа на указанную статью. Возвращаемые поля:

group_id, group_name, created, modified.

Метод GetAllUsersForItemPermission

public DataTable GetAllUsersForItemPermission(int itemId)

Возвращает данные всех пользователей, для которых явно настроены права доступа на указанную статью. Возвращаемые поля:

user_id, login, password, disabled, first_name, last_name, email, created, modified.

Метод GetAllUsersForContentPermission

public DataTable GetAllUsersForContentPermission(int contentId)

Возвращает данные всех пользователей, для которых явно настроены права доступа на заданный контент. Возвращаемые поля:

user_id, login, password, disabled, first_name, last_name, email, created, modified.

Метод GetChildParentGroups

public DataTable GetChildParentGroups()

Возвращает список групп с данными о родительской группе. Возвращаемые поля:

child_group_id, child_group_name, parent_group_id, parent_group_name.

Метод GetGroupInfo

public DataTable GetGroupInfo(int group_id)
public DataTable GetGroupInfo(string group_name)

Возвращает данные об указанной группе по её идентификатору или имени. Возвращаемые поля:

group_id, group_name, created, modified.

Метод GetPermissionLevels

public DataTable GetPermissionLevels()

Возвращает данные об уровнях доступа. Возвращаемые поля:

permission_level_id, permission_level, permission_level_name.

Метод GetRootGroupsForUser

public DataTable GetRootGroupsForUser(int user_id)

Для указанного пользователя возвращает список из group_id групп, в которые он входит.

Метод GetUserInfo

public DataTable GetUserInfo(int user_id)
public DataTable GetUserInfo(string login)

Возвращает данные по указанному пользователю. Возвращаемые поля:

user_id, login, password, disabled, first_name, last_name, email, created, modified.

Метод GetUsersForGroup

public DataTable GetUsersForGroup(int group_id)

Возвращает список пользователей, явно входящих в группу. Возвращаемые поля:

user_id, login, password, disabled, first_name, last_name, email, created, modified.

Метод MoveUsersFromGroupToGroup

public void MoveUsersFromGroupToGroup(int fromGroupId, int toGroupId)

Перемещает пользователей из группы fromGroupId в группу toGroupId.

Метод RemoveAllEntitiesFromContentPermission

public void RemoveAllEntitiesFromContentPermission(int contentId)

Удаляет все права доступа, явно определённые для указанного контента.

Метод RemoveAllEntitiesFromItemPermission

public void RemoveAllEntitiesFromItemPermission(int itemId)

Удаляет все права доступа, явно определённые для указанной статьи.

Метод RemoveAllGroupsFromContentPermission

public void RemoveAllGroupsFromContentPermission(int contentId)

Удаляет все права доступа для групп, явно определённые для указанного контента.

Метод RemoveAllGroupsFromItemPermission

public void RemoveAllGroupsFromItemPermission(int itemId)

Удаляет все права доступа для групп, явно определённые для указанной статьи.

Метод RemoveAllUsersFromContentPermission

public void RemoveAllUsersFromContentPermission(int contentId)

Удаляет все права доступа для пользователей, явно определённые для указанного контента.

Метод RemoveAllUsersFromItemPermission

public void RemoveAllUsersFromItemPermission(int itemId)

Удаляет все права доступа для пользователей, явно определённые для указанной статьи.

Метод RemoveChildGroupFromParentGroup

public void RemoveChildGroupFromParentGroup(int parent_group_id, int child_group_id)

Удаляет связь «Родитель-потомок» для заданных родительской и дочерней групп.

Метод RemoveGroup

public void RemoveGroup(int groupId)

Удаляет указанную группу.

Метод RemoveGroupFromContentPermission

public void RemoveGroupFromContentPermission(int groupId, int contentId)

Удаляет явно определённые права доступа для группы на указанный контент.

Метод RemoveGroupFromItemPermission

public void RemoveGroupFromItemPermission(int groupId, int itemId)

Удаляет явно определённые права доступа для группы на указанную статью.

Метод RemoveUser

bool RemoveUser(int userId)

Удаляет указанного пользователя.

Метод RemoveUserFromContentPermission

public void RemoveUserFromContentPermission(int userId, int contentId)

Удаляет явно определённые права доступа для пользователя на указанный контент.

Метод RemoveUserFromItemPermission

public void RemoveUserFromItemPermission(int userId, int itemId)

Удаляет явно определённые права доступа для пользователя на указанную статью.

Метод RemoveUserFromGroup

public void RemoveUserFromGroup(int userId, int groupId)

Удаляет пользователя userId из группы groupId.

Метод UpdateGroup

public void UpdateGroup(int groupId, string newName)
public void UpdateGroup(int groupId, string newName, bool AllowSharedOwnershipOfItems)

Изменяет имя указанной группы.

Параметры:

Название	Описание
groupId	Идентификатор группы
newName	Новое имя группы

Метод UpdateGroupContentPermission

public void UpdateGroupContentPermission(int groupId, int contentId, int permissionId)
public void UpdateGroupContentPermission(int groupId, int contentId, int permissionId, bool propagateToItems)

Изменяет явно определённые права доступа для группы на указанный контент.

Метод UpdateGroupItemPermission

public void UpdateGroupItemPermission(int groupId, int itemId, int permissionId)

Изменяет явно определённые права доступа для группы на указанную статью.

Метод UpdateUser

public void UpdateUser(int userId, string newUserName, string newPassword, string newFirst_Name, string newLast_Name, string newEmail)

Изменяет данные об указанном пользователе.

Параметры:

Название	Описание
newUserName	Новое имя пользователя
newPassword	Новый пароль пользователя
newFirst_Name	Новое имя персоны-владельца пользователя
newLast_Name	Новая фамилия персоны-владельца пользователя
newEmail	Новый адрес электронной почты персоны-владельца пользователя

Метод UpdateUserContentPermission

public void UpdateUserContentPermission(int userId, int contentId, int permissionId, bool propagateToItems)

Изменяет явно определённые права доступа для пользователя на указанный контент.

Метод UpdateUserItemPermission

public void UpdateUserItemPermission(int userId, int itemId, int permissionId)

Обновляет явно определённые права доступа для пользователя на указанную статью.

Класс ContentItem

Внимание: для использования этого API необходим экземпляр класса DBConnector. В отличие от CRUD-методов класса DBConnector, методы класса ContentItem:

не кэшируют данные статей; поддерживают отправку уведомлений; работают с текущими версиями статей, а не с опубликованными.

Свойства

Свойство FieldValues

public Dictionary<string, ContentItemValue> FieldValues {get; internal set; }

Хэш-таблица значений полей статьи.

Примечание: в отличие от хэш-таблицы Values, используемой в методах класса DBConnector, в данном случае в качестве ключей используются заданные в QP имена полей.

Внимание: данные регистрозависимы.

В качестве значения используется экземпляр класса ContentItemValue, в котором есть свойства, отвечающие за данные статей. Данные поля «Связь» типов M2M и M2O доступны через свойство LinkedItems, а всех полей остальных типов – через свойство Data:

public string Data { get; set; }
public HashSet<int> LinkedItems {get; internal set; }

При создании новой или чтения существующей статьи хэш-таблица с данными о всех полях и их значениях загружается автоматически. Для новой статьи значения по умолчанию не подгружаются, но при сохранении учитываются, если соответствующие поля пришли пустыми.

Свойство Id

public int Id { get; set; }        

Идентификатор статьи. Для новой статьи значение равно 0.