Interface ISharePointUserCollection

Namespace

PnP.Core.Model.Security

Assembly

PnP.Core.dll

Public interface to define a collection of SharePoint users

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

Inherited Members

IQueryable.ElementType

IQueryable.Expression

IQueryable.Provider

IAsyncEnumerable<ISharePointUser>.GetAsyncEnumerator(CancellationToken)

IEnumerable<ISharePointUser>.GetEnumerator()

IDataModelParent.Parent

IDataModelWithContext.PnPContext

IRequestableCollection.Requested

IRequestableCollection.Length

IRequestableCollection.RequestedItems

IRequestableCollection.Clear()

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

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

Extension Methods

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

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

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

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

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

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

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

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

QueryableExtensions.AsAsyncEnumerable<TSource>(IQueryable<TSource>)

QueryableExtensions.AsBatchAsync<TSource>(IQueryable<TSource>)

QueryableExtensions.AsBatchAsync<TSource>(IQueryable<TSource>, Batch)

QueryableExtensions.AsBatch<TSource>(IQueryable<TSource>)

QueryableExtensions.AsBatch<TSource>(IQueryable<TSource>, Batch)

QueryableExtensions.FirstAsync<TSource>(IQueryable<TSource>, Expression<Func<TSource, bool>>, CancellationToken)

QueryableExtensions.FirstAsync<TSource>(IQueryable<TSource>, CancellationToken)

QueryableExtensions.FirstOrDefaultAsync<TSource>(IQueryable<TSource>, Expression<Func<TSource, bool>>, CancellationToken)

QueryableExtensions.FirstOrDefaultAsync<TSource>(IQueryable<TSource>, CancellationToken)

QueryableExtensions.ForEachAsync<T>(IQueryable<T>, Action<T>, CancellationToken)

QueryableExtensions.QueryProperties<TResult>(IQueryable<TResult>, params Expression<Func<TResult, object>>[])

QueryableExtensions.ToArrayAsync<TSource>(IQueryable<TSource>, CancellationToken)

QueryableExtensions.ToDictionaryAsync<TSource, TKey>(IQueryable<TSource>, Func<TSource, TKey>, IEqualityComparer<TKey>, CancellationToken)

QueryableExtensions.ToDictionaryAsync<TSource, TKey>(IQueryable<TSource>, Func<TSource, TKey>, CancellationToken)

QueryableExtensions.ToDictionaryAsync<TSource, TKey, TElement>(IQueryable<TSource>, Func<TSource, TKey>, Func<TSource, TElement>, IEqualityComparer<TKey>, CancellationToken)

QueryableExtensions.ToDictionaryAsync<TSource, TKey, TElement>(IQueryable<TSource>, Func<TSource, TKey>, Func<TSource, TElement>, CancellationToken)

QueryableExtensions.ToListAsync<TSource>(IQueryable<TSource>, CancellationToken)

Methods

Add(string)

Adds a new user

ISharePointUser Add(string userLoginName)

Parameters

userLoginName string

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

Returns

ISharePointUser

AddAsync(string)

Adds a new group

Task<ISharePointUser> AddAsync(string userLoginName)

Parameters

userLoginName string

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

ISharePointUser AddBatch(Batch batch, string userLoginName)

Parameters

batch Batch

Batch to add the request to

userLoginName string

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

Returns

ISharePointUser

AddBatch(string)

Adds a new group

ISharePointUser AddBatch(string userLoginName)

Parameters

userLoginName string

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

Returns

ISharePointUser

AddBatchAsync(Batch, string)

Adds a new group

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

Parameters

batch Batch

Batch to add the request to

userLoginName string

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

Returns

Task<ISharePointUser>

AddBatchAsync(string)

Adds a new group

Task<ISharePointUser> AddBatchAsync(string userLoginName)

Parameters

userLoginName string

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

Returns

Task<ISharePointUser>