Class HttpSubscriptionRepository

Inheritance
System.Object
HttpSubscriptionRepository
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: EPiServer.Social.ActivityStreams.Rest
Assembly: EPiServer.Social.ActivityStreams.Rest.dll
Version: 1.5.4
Syntax
public class HttpSubscriptionRepository : ISubscriptionRepository

Constructors

HttpSubscriptionRepository(IHttpClientFactory, ISubscriptionRequestFactory)

Declaration
public HttpSubscriptionRepository(IHttpClientFactory httpClientFactory, ISubscriptionRequestFactory requestFactory)
Parameters
Type Name Description
IHttpClientFactory httpClientFactory
ISubscriptionRequestFactory requestFactory

Methods

Add(Subscription)

Adds a new subscription to the cloud subscription store.

Declaration
public Subscription Add(Subscription subscription)
Parameters
Type Name Description
Subscription subscription

The subscription to be added

Returns
Type Description
Subscription
Exceptions
Type Condition
SocialCommunicationException

Thrown when the cloud service cannot be reached.

AddAsync(Subscription)

Asynchronously adds a new subscription to the cloud subscription store.

Declaration
public Task<Subscription> AddAsync(Subscription subscription)
Parameters
Type Name Description
Subscription subscription

The subscription to be added

Returns
Type Description
System.Threading.Tasks.Task<Subscription>
Exceptions
Type Condition
SocialCommunicationException

Thrown when the cloud service cannot be reached.

Get(Criteria<SubscriptionFilter>)

Gets a page of subscriptions from the cloud subscription store using the specified criteria.

Declaration
public 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.

Exceptions
Type Condition
SocialCommunicationException

Thrown when the cloud service cannot be reached.

GetAsync(Criteria<SubscriptionFilter>)

Asynchronously gets a page of subscriptions from the cloud subscription store using the specified criteria.

Declaration
public 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.

Exceptions
Type Condition
SocialCommunicationException

Thrown when the cloud service cannot be reached.

Remove(SubscriptionId)

Removes a subscription from the cloud subscription store using the specified subscription Id.

Declaration
public void Remove(SubscriptionId id)
Parameters
Type Name Description
SubscriptionId id

Id of subscription to remove.

Exceptions
Type Condition
SocialCommunicationException

Thrown when the cloud service cannot be reached.

Remove(Criteria<SubscriptionFilter>)

Removes subscriptions from the cloud subscription store using the specified criteria.

Declaration
public void Remove(Criteria<SubscriptionFilter> criteria)
Parameters
Type Name Description
Criteria<SubscriptionFilter> criteria

The criteria for removing subscriptions.

Exceptions
Type Condition
SocialCommunicationException

Thrown when the cloud service cannot be reached.

RemoveAsync(SubscriptionId)

Asynchronously removes a subscription from the cloud subscription store using the specified subscription Id.

Declaration
public Task RemoveAsync(SubscriptionId id)
Parameters
Type Name Description
SubscriptionId id

Id of subscription to remove.

Returns
Type Description
System.Threading.Tasks.Task
Exceptions
Type Condition
SocialCommunicationException

Thrown when the cloud service cannot be reached.

RemoveAsync(Criteria<SubscriptionFilter>)

Asynchronously removes subscriptions from the cloud subscription store using the specified criteria.

Declaration
public Task RemoveAsync(Criteria<SubscriptionFilter> criteria)
Parameters
Type Name Description
Criteria<SubscriptionFilter> criteria

The criteria for removing subscriptions.

Returns
Type Description
System.Threading.Tasks.Task
Exceptions
Type Condition
SocialCommunicationException

Thrown when the cloud service cannot be reached.

Implements

arrow_upward