Interface IListSubscriptionCollection

A collection of list webhook subscriptions

Inherited Members

IDataModelParent.Parent

IDataModelWithContext.PnPContext

IRequestableCollection.Requested

IRequestableCollection.Length

IRequestableCollection.RequestedItems

IRequestableCollection.Clear()

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

IDataModelCollectionLoad<IListSubscription>.LoadBatchAsync(Batch, 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 : IDataModelCollection<IListSubscription>, 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

System.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.

System.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, Int32, String)

Adds a new webhook subscription

Declaration

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

Parameters

System.String notificationUrl A url, where the notification request will be sent

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

System.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

System.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.

System.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, Int32, String)

Adds a new webhook subscription

Declaration

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

Parameters

System.String notificationUrl A url, where the notification request will be sent

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

System.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

System.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.

System.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, Int32, 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

System.String notificationUrl A url, where the notification request will be sent

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

System.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

System.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.

System.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, Int32, String)

Adds a new webhook subscription

Declaration

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

Parameters

System.String notificationUrl A url, where the notification request will be sent

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

System.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

System.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.

System.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, Int32, 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

System.String notificationUrl A url, where the notification request will be sent

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

System.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

System.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.

System.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, Int32, String)

Adds a new webhook subscription

Declaration

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

Parameters

System.String notificationUrl A url, where the notification request will be sent

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

System.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

Returns

IListSubscription An IListSubscription instance

GetByIdAsync(Guid)

Gets webhook subscription

Declaration

Task<IListSubscription> GetByIdAsync(Guid subscriptionId)

Parameters

Guid subscriptionId Subscription's Id, a

Returns

Task<IListSubscription> An IListSubscription instance

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>)