Interface ISharePointUserCollection

Public interface to define a collection of SharePoint users

Inherited Members

IDataModelParent.Parent

IDataModelWithContext.PnPContext

IRequestableCollection.Requested

IRequestableCollection.Length

IRequestableCollection.RequestedItems

IRequestableCollection.Clear()

IDataModelCollectionLoad<ISharePointUser>.LoadAsync(Expression<Func<ISharePointUser, Object>>[])

IDataModelCollectionLoad<ISharePointUser>.LoadBatchAsync(Batch, Expression<Func<ISharePointUser, Object>>[])

Namespace: PnP.Core.Model.Security

Assembly: PnP.Core.dll

Syntax

public interface ISharePointUserCollection : IDataModelCollection<ISharePointUser>, IDataModelParent, IDataModelWithContext, IRequestableCollection, IDataModelCollectionLoad<ISharePointUser>, ISupportModules<ISharePointUserCollection>

Methods

Add(String)

Adds a new user

Declaration

ISharePointUser Add(string userLoginName)

Parameters

System.String userLoginName login name of user to add e.g. "i:0#.f|membership|user@domain.com"

Returns

ISharePointUser

AddAsync(String)

Adds a new group

Declaration

Task<ISharePointUser> AddAsync(string userLoginName)

Parameters

System.String userLoginName login name of user to add e.g. "i:0#.f|membership|user@domain.com"

Returns

Task<ISharePointUser>

AddBatch(Batch, String)

Adds a new group

Declaration

ISharePointUser AddBatch(Batch batch, string userLoginName)

Parameters

Batch batch Batch to add the request to

System.String userLoginName login name of user to add e.g. "i:0#.f|membership|user@domain.com"

Returns

ISharePointUser

AddBatch(String)

Adds a new group

Declaration

ISharePointUser AddBatch(string userLoginName)

Parameters

System.String userLoginName login name of user to add e.g. "i:0#.f|membership|user@domain.com"

Returns

ISharePointUser

AddBatchAsync(Batch, String)

Adds a new group

Declaration

Task<ISharePointUser> AddBatchAsync(Batch batch, string userLoginName)

Parameters

Batch batch Batch to add the request to

System.String userLoginName login name of user to add e.g. "i:0#.f|membership|user@domain.com"

Returns

Task<ISharePointUser>

AddBatchAsync(String)

Adds a new group

Declaration

Task<ISharePointUser> AddBatchAsync(string userLoginName)

Parameters

System.String userLoginName login name of user to add e.g. "i:0#.f|membership|user@domain.com"

Returns

Task<ISharePointUser>

Extension Methods

DataModelCollectionLoadExtensions.LoadBatchAsync<TModel>(IDataModelCollectionLoad<TModel>, Expression<Func<TModel, Object>>[])

DataModelCollectionLoadExtensions.LoadBatchAsync<TModel>(IDataModelCollectionLoad<TModel>, Batch, Expression<Func<TModel, Object>>[])

DataModelCollectionLoadExtensions.LoadBatch<TModel>(IDataModelCollectionLoad<TModel>, Batch, Expression<Func<TModel, Object>>[])

DataModelCollectionLoadExtensions.LoadBatch<TModel>(IDataModelCollectionLoad<TModel>, Expression<Func<TModel, Object>>[])

DataModelCollectionLoadExtensions.Load<TModel>(IDataModelCollectionLoad<TModel>, Expression<Func<TModel, Object>>[])

RequestModuleExtensions.WithHeaders<TModel>(ISupportModules<TModel>, Dictionary<String, String>, Action<Dictionary<String, String>>)

RequestModuleExtensions.WithResponseHeaders<TModel>(ISupportModules<TModel>, Action<Dictionary<String, String>>)

QueryableExtensions.AsRequested<TSource>(IDataModelCollection<TSource>)