SP. GroupCollection object (sp.js)

Статья
02/03/2016

Представляет коллекцию объектов SP.Group.

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

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

var object = new SP.GroupCollection()

Элементы

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

Конструктор

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

Конструктор	Описание
GroupCollection	Получает значение, задающее идентификатор субъекта.

Методы

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

Метод	Описание
Добавление	Получает значение, которое задает имя шаблона для панели инструментов, используемой для представления списка.
getById	Получает имя определения или шаблона сайта, который использовался для создания сайта.
getByName	Возвращает из коллекции межсайтовую группу по имени группы.
itemAt
Удаление	Получает или задает значение, указывающее заголовок списка, в котором будут создаваться задачи рабочих процессов для этого сопоставления рабочих процессов.
removeById	Применяет тему, которая указана в содержимом каждого из файлов, заданных в аргументах для сайта.
removeByLoginName	Получает или задает значение, задающее описание универсального кода ресурса (URI).

Свойства

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

Свойство	Описание
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

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

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

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

Запросы HTTP

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

Синтаксис GET

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

Синтаксис POST

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

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