SP. UserCollection object (sp.js)

Статья
02/03/2016

Представляет коллекцию объектов SP.User object (sp.js)SP. Пользователь object (sp.js).

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

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

var object = new SP.UserCollection()

Элементы

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

Конструктор

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

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

Методы

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

Метод	Описание
Добавление	Получает или задает значение, указывающее отображаемое имя нового представления списка.
addUser	reservemember
getByEmail	Получает или задает значение, указывающее, включено ли в запрос добавление назначений ролей.
getById	Инициализирует новый экземпляр SP. Workflow.WorkflowAssociation object (sp.js).
getByLoginName	Получает пользователя с указанным именем для входа.
itemAt	Добавляет для узла навигации внесенные изменения свойств.
Удаление	Количество ошибок в ходе обновления семейства веб-сайтов.
removeById	Задает источник субъекта.
removeByLoginName	Фиксирует изменение свойств поля.

Properties

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

Свойство	Описание
childItemType
Элемент	Добавляет для узла навигации внесенные изменения свойств.

Пример

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

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

var user;
var visitorsGroup;

function runCode() {

     var clientContext = new SP.ClientContext();
     var groupCollection = clientContext.get_web().get_siteGroups();
     // Get the visitors group, assuming its ID is 4.
     visitorsGroup = groupCollection.getById(4);
     user = clientContext.get_web().get_currentUser();
     var userCollection = visitorsGroup.get_users();
     userCollection.addUser(user);

     clientContext.load(user);
     clientContext.load(visitorsGroup);
     clientContext.executeQueryAsync(Function.createDelegate(this, this.onQuerySucceeded), Function.createDelegate(this, this.onQueryFailed));

}

function onQuerySucceeded() {
    alert(user.get_title() + " added to group " + visitorsGroup.get_title());
}

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

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

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

http://<sitecollection>/<site>/_api/web/sitegroups(groupid)/users

Запросы HTTP

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

Синтаксис GET

GET http://<sitecollection>/<site>/_api/web/sitegroups(groupid)/users

Синтаксис POST

POST http://<sitecollection>/<site>/_api/web/sitegroups(groupid)/users

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