api:permissions
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision | |||
|
api:permissions [2012/06/20 16:00] celutp [AddGroupToContentPermission] |
api:permissions [2012/06/20 17:08] (current) celutp |
||
|---|---|---|---|
| Line 34: | Line 34: | ||
| public void AddGroupToItemPermission(int groupId, int itemId, int permissionId) | public void AddGroupToItemPermission(int groupId, int itemId, int permissionId) | ||
| </code> | </code> | ||
| - | – adds group to the permissions of a given content item (article). | + | Задает (обновляет) права доступа для группы пользователей на заданную статью. |
| ====AddUser==== | ====AddUser==== | ||
| Line 40: | Line 40: | ||
| public int AddUser(string username, string password, string First_Name, string Last_Name, string Email) | public int AddUser(string username, string password, string First_Name, string Last_Name, string Email) | ||
| </code> | </code> | ||
| - | – adds new user and returns new user_id. | + | Метод создает нового пользователя и возвращает его идентификатор. |
| ==== AddUserToContentPermission ==== | ==== AddUserToContentPermission ==== | ||
| Line 47: | Line 47: | ||
| public void AddUserToContentPermission(int userId, int contentId, int permissionId, bool propagateToItems) | public void AddUserToContentPermission(int userId, int contentId, int permissionId, bool propagateToItems) | ||
| </code> | </code> | ||
| - | – adds user to the permissions of a given content area (content). | + | Задает (обновляет) права доступа для пользователя на заданный контент. Параметр //propagateToItems// означает, что эти права доступа также будут применяться к новым статьям, создаваемым в данном контенте |
| - | + | ||
| - | + | ||
| - | – adds user to the permissions of a given content area (content) with backend-only option – propagateToItems, which propagates permissions to items belonging to the specified content area when new items are added. | + | |
| ==== AddUserToGroup ==== | ==== AddUserToGroup ==== | ||
| Line 56: | Line 53: | ||
| public void AddUserToGroup(int userId, int groupId) | public void AddUserToGroup(int userId, int groupId) | ||
| </code> | </code> | ||
| - | – adds user to a group. | + | Выполняет привязку пользователя к группе. |
| ==== AddUserToItemPermission ==== | ==== AddUserToItemPermission ==== | ||
| Line 62: | Line 59: | ||
| public void AddUserToItemPermission(int userId, int itemId, int permissionId) | public void AddUserToItemPermission(int userId, int itemId, int permissionId) | ||
| </code> | </code> | ||
| - | – adds user to the permissions of a given content item (article). | + | Задает (обновляет) права доступа для пользователя на заданную статью. |
| ====AuthenticateUser==== | ====AuthenticateUser==== | ||
| Line 68: | Line 65: | ||
| public int AuthenticateUser(string username, string password) | public int AuthenticateUser(string username, string password) | ||
| </code> | </code> | ||
| - | – returns user_id or 0 (zero) if user is not found or incorrect credentials. | + | Производит попытку аутентификации пользователя в соответствии с заданными параметрами. Возвращает идентификатор пользователя при успешной аутентификации, либо 0 -- при неуспешной. |
| ==== CopyUsersFromGroupToGroup ==== | ==== CopyUsersFromGroupToGroup ==== | ||
| Line 74: | Line 71: | ||
| public void CopyUsersFromGroupToGroup(int fromGroupId, int toGroupId) | public void CopyUsersFromGroupToGroup(int fromGroupId, int toGroupId) | ||
| </code> | </code> | ||
| - | – copies users from group to another. | + | Копирует пользователей из группы //fromGroupId// в группу //toGroupId//. Копируются только отсутствующие пользователи. |
| ==== GetAllGroups ==== | ==== GetAllGroups ==== | ||
| Line 80: | Line 77: | ||
| public DataTable GetAllGroups() | public DataTable GetAllGroups() | ||
| </code> | </code> | ||
| - | – returns a list of all groups; returned fields: group_id, group_name, created, modified. | + | Возвращает все группы пользователей. Возвращаемые поля: group_id, group_name, created, modified. |
| ==== GetAllGroupsForContentPermission ==== | ==== GetAllGroupsForContentPermission ==== | ||
| Line 86: | Line 83: | ||
| public DataTable GetAllGroupsForContentPermission(int contentId) | public DataTable GetAllGroupsForContentPermission(int contentId) | ||
| </code> | </code> | ||
| - | – returns a list of groups directly listed on the permissions of a given content area (content); returned fields: group_id, group_name, created, modified. | + | Возвращает все группы пользователей, для которых явно настроены права доступа на заданный контент. Возвращаемые поля: group_id, group_name, created, modified. |
| ==== GetAllGroupsForItemPermission ==== | ==== GetAllGroupsForItemPermission ==== | ||
| Line 92: | Line 89: | ||
| public DataTable GetAllGroupsForItemPermission(int itemId) | public DataTable GetAllGroupsForItemPermission(int itemId) | ||
| </code> | </code> | ||
| - | – returns a list of groups directly listed on the permissions of a given content item (article); returned fields: group_id, group_name, created, modified. | + | Возвращает все группы пользователей, для которых явно настроены права доступа на заданную статью. Возвращаемые поля: group_id, group_name, created, modified. |
| ==== GetAllUsersForItemPermission ==== | ==== GetAllUsersForItemPermission ==== | ||
| Line 98: | Line 95: | ||
| public DataTable GetAllUsersForItemPermission(int itemId) | public DataTable GetAllUsersForItemPermission(int itemId) | ||
| </code> | </code> | ||
| - | – returns a list of users directly listed on the permissions of a given content item (article); returned fields: user_id, login, password, disabled, first_name, last_name, email, created, modified. | + | Возвращает всех пользователей, для которых явно настроены права доступа на заданную статью. Возвращаемые поля: user_id, login, password, disabled, first_name, last_name, email, created, modified. |
| ==== GetAllUsersForContentPermission ==== | ==== GetAllUsersForContentPermission ==== | ||
| Line 104: | Line 101: | ||
| public DataTable GetAllUsersForContentPermission(int contentId) | public DataTable GetAllUsersForContentPermission(int contentId) | ||
| </code> | </code> | ||
| - | – returns a list of users directly listed on the permissions of a given content area (content); returned fields: user_id, login, password, disabled, first_name, last_name, email, created, modified. | + | Возвращает всех пользователей, для которых явно настроены права доступа на заданный контент. Возвращаемые поля: user_id, login, password, disabled, first_name, last_name, email, created, modified. |
| - | ==== RemoveAllUsersFromContentPermission ==== | + | |
| ==== GetChildParentGroups ==== | ==== GetChildParentGroups ==== | ||
| Line 111: | Line 107: | ||
| public DataTable GetChildParentGroups() | public DataTable GetChildParentGroups() | ||
| </code> | </code> | ||
| - | – returns a list of groups with parent-child associations; returned fields: child_group_id, child_group_name, parent_group_id, parent_group_name. | + | Возвращает список групп с информацией о родителе. Возвращаемые поля: child_group_id, child_group_name, parent_group_id, parent_group_name. |
| ====GetGroupInfo==== | ====GetGroupInfo==== | ||
| Line 118: | Line 114: | ||
| public DataTable GetGroupInfo(string group_name) | public DataTable GetGroupInfo(string group_name) | ||
| </code> | </code> | ||
| - | – returns information for a particular group; the returned fieds are: group_id, group_name, created, modified. | + | Возвращает информацию о выбранной группе по идентификатору или имени. Возвращаемые поля: group_id, group_name, created, modified. |
| - | – returns information for a particular group; the returned fieds are: group_id, group_name, created, modified. | + | |
| ==== GetPermissionLevels ==== | ==== GetPermissionLevels ==== | ||
| Line 125: | Line 120: | ||
| public DataTable GetPermissionLevels() | public DataTable GetPermissionLevels() | ||
| </code> | </code> | ||
| - | – returns a DataTable with a list of permission levels and permission ids. Permission_level_id is needed to be used for methods like AddUserToItemPermission() and many others; returned fields: permission_level_id, permission_level, permission_level_name | + | Возвращает информацию об уровнях доступа. Возвращаемые поля: permission_level_id, permission_level, permission_level_name |
| ==== GetRootGroupsForUser ==== | ==== GetRootGroupsForUser ==== | ||
| Line 131: | Line 126: | ||
| public DataTable GetRootGroupsForUser(int user_id) | public DataTable GetRootGroupsForUser(int user_id) | ||
| </code> | </code> | ||
| - | – returns a list of group_id’s for a specified user (returns only groups to which user is associated directly). | + | |
| + | Для заданного пользователя возвращается список групп, в которые он входит явно. Возвращаемые поля: group_id. | ||
| | | ||
| ====GetUserInfo==== | ====GetUserInfo==== | ||
| Line 138: | Line 134: | ||
| public DataTable GetUserInfo(string login) | public DataTable GetUserInfo(string login) | ||
| </code> | </code> | ||
| - | – returns DataTable with fields: user_id, login, password, disabled, first_name, last_name, email, created, modified. | + | Возвращает информацию о выбранном пользователе по идентификатору или имени. Возвращаемые поля: user_id, login, password, disabled, first_name, last_name, email, created, modified. |
| - | + | ||
| - | – returns DataTable with fields: user_id, login, password, disabled, first_name, last_name, email, created, modified. | + | |
| ==== GetUsersForGroup ==== | ==== GetUsersForGroup ==== | ||
| Line 146: | Line 140: | ||
| public DataTable GetUsersForGroup(int group_id) | public DataTable GetUsersForGroup(int group_id) | ||
| </code> | </code> | ||
| - | – returns a list of users for a specified group; returned fields: user_id, login, password, disabled, first_name, last_name, email, created, modified. | + | Возвращает список пользователей, явно входящих в группу. Возвращаемые поля: user_id, login, password, disabled, first_name, last_name, email, created, modified. |
| ==== MoveUsersFromGroupToGroup ==== | ==== MoveUsersFromGroupToGroup ==== | ||
| Line 152: | Line 146: | ||
| public void MoveUsersFromGroupToGroup(int fromGroupId, int toGroupId) | public void MoveUsersFromGroupToGroup(int fromGroupId, int toGroupId) | ||
| </code> | </code> | ||
| - | – moves user from one group to another. | + | Перемещает пользователей из группы //fromGroupId// в группу //toGroupId//. |
| ==== RemoveAllEntitiesFromContentPermission ==== | ==== RemoveAllEntitiesFromContentPermission ==== | ||
| Line 158: | Line 152: | ||
| public void RemoveAllEntitiesFromContentPermission(int contentId) | public void RemoveAllEntitiesFromContentPermission(int contentId) | ||
| </code> | </code> | ||
| - | – removes all users and groups directly listed on the permissions of a given content area (content). | + | Удаляет все права доступа, явно определенные для данного контента. |
| ==== RemoveAllEntitiesFromItemPermission ==== | ==== RemoveAllEntitiesFromItemPermission ==== | ||
| Line 164: | Line 158: | ||
| public void RemoveAllEntitiesFromItemPermission(int itemId) | public void RemoveAllEntitiesFromItemPermission(int itemId) | ||
| </code> | </code> | ||
| - | – removes all users and all groups directly listed on the permissions of a given content item (article). | + | Удаляет все права доступа, явно определенные для данной статьи. |
| ==== RemoveAllGroupsFromContentPermission ==== | ==== RemoveAllGroupsFromContentPermission ==== | ||
| Line 170: | Line 164: | ||
| public void RemoveAllGroupsFromContentPermission(int contentId) | public void RemoveAllGroupsFromContentPermission(int contentId) | ||
| </code> | </code> | ||
| - | – removes all groups directly listed on the permissions of a given content area (content). | + | Удаляет все права доступа групп пользователей, явно определенные для данного контента. |
| ==== RemoveAllGroupsFromItemPermission ==== | ==== RemoveAllGroupsFromItemPermission ==== | ||
| Line 176: | Line 170: | ||
| public void RemoveAllGroupsFromItemPermission(int itemId) | public void RemoveAllGroupsFromItemPermission(int itemId) | ||
| </code> | </code> | ||
| - | – removes all users directly listed on the permissions of a given content item (article). | + | Удаляет все права доступа групп пользователей, явно определенные для данной статьи. |
| ==== RemoveAllUsersFromContentPermission ==== | ==== RemoveAllUsersFromContentPermission ==== | ||
| Line 182: | Line 176: | ||
| public void RemoveAllUsersFromContentPermission(int contentId) | public void RemoveAllUsersFromContentPermission(int contentId) | ||
| </code> | </code> | ||
| - | – removes all users directly listed on the permissions of a given content area (content). | + | Удаляет все права доступа пользователей, явно определенные для данного контента. |
| ==== RemoveAllUsersFromItemPermission ==== | ==== RemoveAllUsersFromItemPermission ==== | ||
| Line 188: | Line 182: | ||
| public void RemoveAllUsersFromItemPermission(int itemId) | public void RemoveAllUsersFromItemPermission(int itemId) | ||
| </code> | </code> | ||
| - | – removes all users directly listed on the permissions of a given content item (article). | + | Удаляет все права доступа пользователей, явно определенные для данной статьи. |
| Line 195: | Line 189: | ||
| public void RemoveChildGroupFromParentGroup(int parent_group_id, int child_group_id) | public void RemoveChildGroupFromParentGroup(int parent_group_id, int child_group_id) | ||
| </code> | </code> | ||
| - | – removes a specified group as a child (child_group_id) of another group (parent_group_id) | + | Удаляет связь родитель-потомок для заданной родительской и дочерней групп. |
| ==== RemoveGroup ==== | ==== RemoveGroup ==== | ||
| Line 201: | Line 195: | ||
| public void RemoveGroup(int groupId) | public void RemoveGroup(int groupId) | ||
| </code> | </code> | ||
| - | – removes group from the system. | + | Удаляет группу пользователей из системы |
| ==== RemoveGroupFromContentPermission ==== | ==== RemoveGroupFromContentPermission ==== | ||
| Line 207: | Line 201: | ||
| public void RemoveGroupFromContentPermission(int groupId, int contentId) | public void RemoveGroupFromContentPermission(int groupId, int contentId) | ||
| </code> | </code> | ||
| - | – removes a given group that is directly listed on the permissions of a given content area (content). | + | Удаляет явно определенные права доступа группы пользователей на данный контент. |
| ==== RemoveGroupFromItemPermission ==== | ==== RemoveGroupFromItemPermission ==== | ||
| Line 213: | Line 207: | ||
| public void RemoveGroupFromItemPermission(int groupId, int itemId) | public void RemoveGroupFromItemPermission(int groupId, int itemId) | ||
| </code> | </code> | ||
| - | – removes a given group that is directly listed on the permissions of a given content item (article). | + | Удаляет явно определенные права доступа группы пользователей на данную статью. |
| ====RemoveUser==== | ====RemoveUser==== | ||
| Line 219: | Line 213: | ||
| bool RemoveUser(int userId) | bool RemoveUser(int userId) | ||
| </code> | </code> | ||
| - | – deletes user from the system. | + | Удаляет пользователя из системы |
| ==== RemoveUserFromContentPermission ==== | ==== RemoveUserFromContentPermission ==== | ||
| Line 225: | Line 219: | ||
| public void RemoveUserFromContentPermission(int userId, int contentId) | public void RemoveUserFromContentPermission(int userId, int contentId) | ||
| </code> | </code> | ||
| - | – removes a given user who is directly listed on the permissions of a given content area (content). | + | Удаляет явно определенные права доступа пользователя на данный контент. |
| ==== RemoveUserFromItemPermission ==== | ==== RemoveUserFromItemPermission ==== | ||
| Line 231: | Line 225: | ||
| public void RemoveUserFromItemPermission(int userId, int itemId) | public void RemoveUserFromItemPermission(int userId, int itemId) | ||
| </code> | </code> | ||
| - | – removes a given user who is directly listed on the permissions of a given content item (article). | + | Удаляет явно определенные права доступа пользователя на данную статью. |
| ==== RemoveUserFromGroup ==== | ==== RemoveUserFromGroup ==== | ||
| Line 237: | Line 231: | ||
| public void RemoveUserFromGroup(int userId, int groupId) | public void RemoveUserFromGroup(int userId, int groupId) | ||
| </code> | </code> | ||
| - | – removes user from a group | + | Удаляет привязку пользователя к группе |
| ====UpdateGroup==== | ====UpdateGroup==== | ||
| Line 245: | Line 238: | ||
| public void UpdateGroup(int groupId, string newName, bool AllowSharedOwnershipOfItems) | public void UpdateGroup(int groupId, string newName, bool AllowSharedOwnershipOfItems) | ||
| </code> | </code> | ||
| - | + | Обновляет информацию о группе с заданным идентификатором. | |
| - | – updates group name for a given groupId. | + | |
| - | – updates group name and AllowSharedOwnershipOfItems for a given groupId; AllowSharedOwnershipOfItem – refers to the backend only option that allows users that belong to the same group to share user’s permissions when a new article is created. | + | |
| ==== UpdateGroupContentPermission ==== | ==== UpdateGroupContentPermission ==== | ||
| Line 254: | Line 245: | ||
| public void UpdateGroupContentPermission(int groupId, int contentId, int permissionId, bool propagateToItems) | public void UpdateGroupContentPermission(int groupId, int contentId, int permissionId, bool propagateToItems) | ||
| </code> | </code> | ||
| - | updates permissions for a given group that is directly listed on the permissions of a given content area (content). | + | Обновляет явно определенные права доступа группы пользователей на данный контент. |
| - | updates permissions for a given group that is directly listed on the permissions of a given content area (content); | + | |
| - | propagateToItems - propagates permissions to items belonging to the specified content area when new items are added. | + | |
| ==== UpdateGroupItemPermission ==== | ==== UpdateGroupItemPermission ==== | ||
| Line 264: | Line 252: | ||
| </code> | </code> | ||
| | | ||
| - | updates permissions for a given group that is directly listed on the permissions of a given content item (article). | + | Обновляет явно определенные права доступа группы пользователей на данную статью. |
| ====UpdateUser==== | ====UpdateUser==== | ||
| Line 270: | Line 258: | ||
| public void UpdateUser(int userId, string newUserName, string newPassword, string newFirst_Name, string newLast_Name, string newEmail) | public void UpdateUser(int userId, string newUserName, string newPassword, string newFirst_Name, string newLast_Name, string newEmail) | ||
| </code> | </code> | ||
| - | updates information for a given user_id. | + | Обновляет информацию о пользователе с заданным идентификатором. |
| ==== UpdateUserContentPermission ==== | ==== UpdateUserContentPermission ==== | ||
| Line 276: | Line 264: | ||
| public void UpdateUserContentPermission(int userId, int contentId, int permissionId, bool propagateToItems) | public void UpdateUserContentPermission(int userId, int contentId, int permissionId, bool propagateToItems) | ||
| </code> | </code> | ||
| - | updates permissions for a given user who is directly listed on the permissions of a given content area (content); propagateToItems - propagates permissions to items belonging to the specified content area when new items are added. | + | Обновляет явно определенные права доступа пользователя на данный контент. |
| ====UpdateUserItemPermission ==== | ====UpdateUserItemPermission ==== | ||
| Line 282: | Line 270: | ||
| public void UpdateUserItemPermission(int userId, int itemId, int permissionId) | public void UpdateUserItemPermission(int userId, int itemId, int permissionId) | ||
| </code> | </code> | ||
| - | updates permissions for a given user who is directly listed on the permissions of a given content item (article). | + | Обновляет явно определенные права доступа пользователя на данную статью. |
api/permissions.txt · Last modified: 2012/06/20 17:08 by celutp
Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Noncommercial-Share Alike 4.0 International
