SP. RoleDefinitionCollection object (sp.js)

Статья
02/03/2016

Представляет коллекцию объектов SP.RoleDefinition, задающих определения ролей, доступные для использования на этом веб-сайте.

Дата последнего изменения: 9 марта 2015 г.

Область применения: apps for SharePoint | SharePoint Foundation 2013 | SharePoint Server 2013

var object = new SP.RoleDefinitionCollection()

Элементы

Объект RoleDefinitionCollection содержит следующие элементы.

Конструктор

Объект RoleDefinitionCollection имеет следующий конструктор.

Конструктор	Описание
RoleDefinitionCollection	Инициализирует новый экземпляр объекта SP.RegionalSettings.

Методы

Объект RoleDefinitionCollection содержит следующие методы.

Метод	Описание
Добавление	Добавляет новое определение роли в коллекцию на основе сведений об определении роли.
getById	Получает идентификатор измененного типа контента.
getByName	Получает значение, которое задает схему XML, представляющую коллекцию.
getByType	Представляет данные исходящих, необходимые для принятия веб-запроса.
itemAt	Представляет семейство веб-сайтов в веб-приложении, включая веб-сайт верхнего уровня и все его дочерние сайты.

Properties

Объект RoleDefinitionCollection имеет следующие свойства.

Свойство	Описание
childItemType
Элемент	Представляет семейство веб-сайтов в веб-приложении, включая веб-сайт верхнего уровня и все его дочерние сайты.

Пример

В следующем примере создается кнопку ввода на страницу приложения, который определяет новые роли и добавляет его в коллекцию определений ролей.

<asp:Content ID="Main" ContentPlaceHolderID="PlaceHolderMain" runat="server">
<script type="text/ecmascript" language="ecmascript">

    var roleDefinitionCollection;
    var roleDefinition;
    function runCode() {
        var clientContext = new SP.ClientContext.get_current();
        if (clientContext != undefined && clientContext != null) {
            var web = clientContext.get_web();

            var permissionsManage = new SP.BasePermissions();
            permissionsManage.set(SP.PermissionKind.manageUsers);

            // Specify properties of the role definition.
            var roleCreationInfo = new SP.RoleDefinitionCreationInformation();
            roleCreationInfo.set_basePermissions(permissionsManage);
            roleCreationInfo.set_description('Role for managing user permissions.');
            roleCreationInfo.set_name('Manage User');
            roleCreationInfo.set_order(1);

            // Add to the role definitions collection.
            this.roleDefinitionCollection = web.get_roleDefinitions();
            this.roleDefinition = this.roleDefinitionCollection.add(roleCreationInfo);

            clientContext.load(roleDefinition);

            clientContext.executeQueryAsync(Function.createDelegate(this, this.onQuerySucceeded), Function.createDelegate(this, this.onQueryFailed));
        }
    }

    function onQuerySucceeded() {
        alert('Created role: ' + this.roleDefinition.get_name());
    }

    function onQueryFailed(sender, args) {
        alert('Request failed. ' + args.get_message() + '\n' + args.get_stackTrace());
    }

</script>

    <input id="Button1" type="button" value="Run Code" onclick="runCode()" />

</asp:Content>

Конечная точка ресурса REST

Ресурс RoleDefinitionCollection более подробные сведения.

Структура URI конечной точки

http://<sitecollection>/<site>/_api/web/roledefinitions

Запросы HTTP

Этот ресурс поддерживает следующие команды HTTP:

Синтаксис GET

GET http://<sitecollection>/<site>/_api/web/roledefinitions

Синтаксис POST

POST http://<sitecollection>/<site>/_api/web/roledefinitions

Поделиться через