Interface IListSubscriptionCollection

A collection of list webhook subscriptions

Inherited Members

IQueryable.ElementType

IQueryable.Expression

IQueryable.Provider

IAsyncEnumerable<IListSubscription>.GetAsyncEnumerator(CancellationToken)

IEnumerable<IListSubscription>.GetEnumerator()

IDataModelParent.Parent

IDataModelWithContext.PnPContext

IRequestableCollection.Requested

IRequestableCollection.Length

IRequestableCollection.RequestedItems

IRequestableCollection.Clear()

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

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

IDataModelCollectionDeleteByGuidId.DeleteById(Guid)

IDataModelCollectionDeleteByGuidId.DeleteByIdAsync(Guid)

IDataModelCollectionDeleteByGuidId.DeleteByIdBatch(Guid)

IDataModelCollectionDeleteByGuidId.DeleteByIdBatchAsync(Guid)

IDataModelCollectionDeleteByGuidId.DeleteByIdBatch(Batch, Guid)

IDataModelCollectionDeleteByGuidId.DeleteByIdBatchAsync(Batch, Guid)

Namespace: PnP.Core.Model.SharePoint

Assembly: PnP.Core.dll

Syntax

public interface IListSubscriptionCollection : IQueryable<IListSubscription>, IQueryable, IAsyncEnumerable<IListSubscription>, IDataModelCollection<IListSubscription>, IEnumerable<IListSubscription>, IEnumerable, IDataModelParent, IDataModelWithContext, IRequestableCollection, IDataModelCollectionLoad<IListSubscription>, IDataModelCollectionDeleteByGuidId, ISupportModules<IListSubscriptionCollection>

Methods

Add(string, DateTime, string)

Adds a new webhook subscription

Declaration

IListSubscription Add(string notificationUrl, DateTime expirationDate, string clientState = null)

Parameters

string notificationUrl A url, where the notification request will be sent

DateTime expirationDate A date, when the subscription will expire. Expiration date should not be greater than 6 months period.

string clientState A string, which represents client information. You can use this for validating notifications, tagging different subscriptions, or other reasons.

Returns

IListSubscription An IListSubscription instance

Add(string, int, string)

Adds a new webhook subscription

Declaration

IListSubscription Add(string notificationUrl, int validityInMonths = 6, string clientState = null)

Parameters

string notificationUrl A url, where the notification request will be sent

int validityInMonths How many months the subscription should stay valid. The maximum is 6 months.

string clientState A string, which represents client information. You can use this for validating notifications, tagging different subscriptions, or other reasons.

Returns

IListSubscription An IListSubscription instance

AddAsync(string, DateTime, string)

Adds a new webhook subscription

Declaration

Task<IListSubscription> AddAsync(string notificationUrl, DateTime expirationDate, string clientState = null)

Parameters

string notificationUrl A url, where the notification request will be sent

DateTime expirationDate A date, when the subscription will expire. Expiration date should not be greater than 6 months period.

string clientState A string, which represents client information. You can use this for validating notifications, tagging different subscriptions, or other reasons.

Returns

Task<IListSubscription> An IListSubscription instance

AddAsync(string, int, string)

Adds a new webhook subscription

Declaration

Task<IListSubscription> AddAsync(string notificationUrl, int validityInMonths = 6, string clientState = null)

Parameters

string notificationUrl A url, where the notification request will be sent

int validityInMonths How many months the subscription should stay valid. The maximum is 6 months.

string clientState A string, which represents client information. You can use this for validating notifications, tagging different subscriptions, or other reasons.

Returns

Task<IListSubscription> An IListSubscription instance

AddBatch(Batch, string, DateTime, string)

Adds a new webhook subscription

Declaration

IListSubscription AddBatch(Batch batch, string notificationUrl, DateTime expirationDate, string clientState = null)

Parameters

Batch batch Batch to use

string notificationUrl A url, where the notification request will be sent

DateTime expirationDate A date, when the subscription will expire. Expiration date should not be greater than 6 months period.

string clientState A string, which represents client information. You can use this for validating notifications, tagging different subscriptions, or other reasons.

Returns

IListSubscription An IListSubscription instance

AddBatch(Batch, string, int, string)

Adds a new webhook subscription

Declaration

IListSubscription AddBatch(Batch batch, string notificationUrl, int validityInMonths = 6, string clientState = null)

Parameters

Batch batch Batch to use

string notificationUrl A url, where the notification request will be sent

int validityInMonths How many months the subscription should stay valid. The maximum is 6 months.

string clientState A string, which represents client information. You can use this for validating notifications, tagging different subscriptions, or other reasons.

Returns

IListSubscription An IListSubscription instance

AddBatch(string, DateTime, string)

Adds a new webhook subscription

Declaration

IListSubscription AddBatch(string notificationUrl, DateTime expirationDate, string clientState = null)

Parameters

string notificationUrl A url, where the notification request will be sent

DateTime expirationDate A date, when the subscription will expire. Expiration date should not be greater than 6 months period.

string clientState A string, which represents client information. You can use this for validating notifications, tagging different subscriptions, or other reasons.

Returns

IListSubscription An IListSubscription instance

AddBatch(string, int, string)

Adds a new webhook subscription

Declaration

IListSubscription AddBatch(string notificationUrl, int validityInMonths = 6, string clientState = null)

Parameters

string notificationUrl A url, where the notification request will be sent

int validityInMonths How many months the subscription should stay valid. The maximum is 6 months.

string clientState A string, which represents client information. You can use this for validating notifications, tagging different subscriptions, or other reasons.

Returns

IListSubscription An IListSubscription instance

AddBatchAsync(Batch, string, DateTime, string)

Adds a new webhook subscription

Declaration

Task<IListSubscription> AddBatchAsync(Batch batch, string notificationUrl, DateTime expirationDate, string clientState = null)

Parameters

Batch batch Batch to use

string notificationUrl A url, where the notification request will be sent

DateTime expirationDate A date, when the subscription will expire. Expiration date should not be greater than 6 months period.

string clientState A string, which represents client information. You can use this for validating notifications, tagging different subscriptions, or other reasons.

Returns

Task<IListSubscription> An IListSubscription instance

AddBatchAsync(Batch, string, int, string)

Adds a new webhook subscription

Declaration

Task<IListSubscription> AddBatchAsync(Batch batch, string notificationUrl, int validityInMonths = 6, string clientState = null)

Parameters

Batch batch Batch to use

string notificationUrl A url, where the notification request will be sent

int validityInMonths How many months the subscription should stay valid. The maximum is 6 months.

string clientState A string, which represents client information. You can use this for validating notifications, tagging different subscriptions, or other reasons.

Returns

Task<IListSubscription> An IListSubscription instance

AddBatchAsync(string, DateTime, string)

Adds a new webhook subscription

Declaration

Task<IListSubscription> AddBatchAsync(string notificationUrl, DateTime expirationDate, string clientState = null)

Parameters

string notificationUrl A url, where the notification request will be sent

DateTime expirationDate A date, when the subscription will expire. Expiration date should not be greater than 6 months period.

string clientState A string, which represents client information. You can use this for validating notifications, tagging different subscriptions, or other reasons.

Returns

Task<IListSubscription> An IListSubscription instance

AddBatchAsync(string, int, string)

Adds a new webhook subscription

Declaration

Task<IListSubscription> AddBatchAsync(string notificationUrl, int validityInMonths = 6, string clientState = null)

Parameters

string notificationUrl A url, where the notification request will be sent

int validityInMonths How many months the subscription should stay valid. The maximum is 6 months.

string clientState A string, which represents client information. You can use this for validating notifications, tagging different subscriptions, or other reasons.

Returns

Task<IListSubscription> An IListSubscription instance

GetById(Guid)

Gets webhook subscription

Declaration

IListSubscription GetById(Guid subscriptionId)

Parameters

Guid subscriptionId Subscription's Id, a Guid

Returns

IListSubscription An IListSubscription instance

GetByIdAsync(Guid)

Gets webhook subscription

Declaration

Task<IListSubscription> GetByIdAsync(Guid subscriptionId)

Parameters

Guid subscriptionId Subscription's Id, a Guid

Returns

Task<IListSubscription> An IListSubscription instance

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)