Interface ISubscriptionRepository
The ISubscriptionRepository interface describes a component capable of creating, deleting, and reading subscription data from an underlying data store.
Namespace: EPiServer.Social.ActivityStreams.Core
Assembly: EPiServer.Social.ActivityStreams.Core.dll
Version: 1.5.4Syntax
public interface ISubscriptionRepositoryMethods
Add(Subscription)
Adds a subscription in the underlying store.
Declaration
Subscription Add(Subscription subscription)Parameters
| Type | Name | Description |
|---|---|---|
| Subscription | subscription | The subscription information. |
Returns
| Type | Description |
|---|---|
| Subscription | The created subscription. |
AddAsync(Subscription)
Asynchronously adds a subscription in the underlying store.
Declaration
Task<Subscription> AddAsync(Subscription subscription)Parameters
| Type | Name | Description |
|---|---|---|
| Subscription | subscription | The subscription information. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Subscription> | The created subscription. |
Get(Criteria<SubscriptionFilter>)
Gets a page of subscriptions from the underlying subscription store given some criteria.
Declaration
ResultPage<Subscription> Get(Criteria<SubscriptionFilter> criteria)Parameters
| Type | Name | Description |
|---|---|---|
| Criteria<SubscriptionFilter> | criteria | The criteria for retrieving subscriptions. |
Returns
| Type | Description |
|---|---|
| ResultPage<Subscription> | A page of subscriptions. |
GetAsync(Criteria<SubscriptionFilter>)
Asynchronously gets a page of subscriptions from the underlying subscription store given some criteria.
Declaration
Task<ResultPage<Subscription>> GetAsync(Criteria<SubscriptionFilter> criteria)Parameters
| Type | Name | Description |
|---|---|---|
| Criteria<SubscriptionFilter> | criteria | The criteria for retrieving subscriptions. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<ResultPage<Subscription>> | A page of subscriptions. |
Remove(SubscriptionId)
Removes a subscription from the underlying subscription store using the specified subscription Id.
Declaration
void Remove(SubscriptionId id)Parameters
| Type | Name | Description |
|---|---|---|
| SubscriptionId | id | Id of subscription to remove. |
Remove(Criteria<SubscriptionFilter>)
Removes subscriptions from the underlying subscription store using the specified criteria.
Declaration
void Remove(Criteria<SubscriptionFilter> criteria)Parameters
| Type | Name | Description |
|---|---|---|
| Criteria<SubscriptionFilter> | criteria | The criteria for removing subscriptions. |
RemoveAsync(SubscriptionId)
Asynchronously removes a subscription from the underlying subscription store using the specified subscription Id.
Declaration
Task RemoveAsync(SubscriptionId id)Parameters
| Type | Name | Description |
|---|---|---|
| SubscriptionId | id | Id of subscription to remove. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task |
RemoveAsync(Criteria<SubscriptionFilter>)
Asynchronously removes subscriptions from the underlying subscription store using the specified criteria.
Declaration
Task RemoveAsync(Criteria<SubscriptionFilter> criteria)Parameters
| Type | Name | Description |
|---|---|---|
| Criteria<SubscriptionFilter> | criteria | The criteria for removing subscriptions. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task |