DataWeb
Search Results for

    Show / Hide Table of Contents

    Interface INewsletterSubscriberStore

    Provides storage operations for newsletter subscribers.

    Namespace: DataWeb.Newsletter
    Assembly: DataWeb.Core.dll
    Syntax
    public interface INewsletterSubscriberStore

    Properties

    Name

    Gets the name of the store.

    Declaration
    string Name { get; }
    Property Value
    Type Description
    string

    Methods

    ConvertStringToStatus(string)

    Converts the given string value to a subscriber status.

    Declaration
    SubscriberStatus ConvertStringToStatus(string value)
    Parameters
    Type Name Description
    string value
    Returns
    Type Description
    SubscriberStatus

    DeserializeAdditionalValues(string)

    Deserializes the additional values of a subscriber.

    Declaration
    List<NewsletterSubscriber.AdditionalValue> DeserializeAdditionalValues(string value)
    Parameters
    Type Name Description
    string value
    Returns
    Type Description
    List<NewsletterSubscriber.AdditionalValue>

    GetSubscriberAsync(NewsletterSubscriberFilter, CancellationToken)

    Gets the subscriber that matches the given NewsletterSubscriberFilter.

    Declaration
    Task<NewsletterSubscriber> GetSubscriberAsync(NewsletterSubscriberFilter filter, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    NewsletterSubscriberFilter filter
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<NewsletterSubscriber>

    GetSubscriberCountAsync(NewsletterSubscriberFilter, CancellationToken)

    Gets the number of subscribers that match the given NewsletterSubscriberFilter.

    Declaration
    Task<long> GetSubscriberCountAsync(NewsletterSubscriberFilter filter, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    NewsletterSubscriberFilter filter
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<long>

    GetSubscribersAsync(NewsletterSubscriberFilter, CancellationToken)

    Gets a list of subscribers that match the given NewsletterSubscriberFilter.

    Declaration
    Task<IEnumerable<NewsletterSubscriber>> GetSubscribersAsync(NewsletterSubscriberFilter filter, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    NewsletterSubscriberFilter filter
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<IEnumerable<NewsletterSubscriber>>

    RemoveAsync(string, CancellationToken)

    Removes the subscriber with the given Id.

    Declaration
    Task RemoveAsync(string id, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string id
    CancellationToken cancellationToken
    Returns
    Type Description
    Task

    RemoveGroupAsync(string, string, CancellationToken)

    Removes the given group from the subscriber.

    Declaration
    Task RemoveGroupAsync(string id, string group, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string id
    string group
    CancellationToken cancellationToken
    Returns
    Type Description
    Task

    SetAsync(NewsletterSubscriber, CancellationToken)

    Sets the given NewsletterSubscriber.

    Declaration
    Task SetAsync(NewsletterSubscriber subscriber, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    NewsletterSubscriber subscriber
    CancellationToken cancellationToken
    Returns
    Type Description
    Task
    In this article
    Back to top Generated by DocFX