DataWeb
Search Results for

    Show / Hide Table of Contents

    Class ModuleSubscriberReport

    Report module that exports newsletter subscribers to an Excel file.

    Inheritance
    object
    Module
    ModuleReport
    ModuleSubscriberReport
    Inherited Members
    ModuleReport.ValidateReportDataAsync(Item, Dictionary<string, object>, CancellationToken)
    ModuleReport.GetContentTypeAsync(Item, Dictionary<string, object>, CancellationToken)
    Module.section
    Module.navigationContext
    Module.serviceProvider
    Module.ValidateAsync(Item, Dictionary<string, object>, CancellationToken)
    Module.SaveAsync(Item, Dictionary<string, object>, CancellationToken)
    Module.IsCompletedAsync(Item, Section, CancellationToken)
    Module.CloneAsync(Item, Item, CancellationToken)
    Module.GetProvidedValues(Dictionary<string, object>)
    Module.GetSectionNotificationCountAsync(CancellationToken)
    Module.GetActionsAsync(CancellationToken)
    Module.ProcessActionAsync(ContextAction, IUser, List<string>, List<Form.ProvidedValue>, NavigationContext, CancellationToken)
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: DataWeb.Structure.Modules
    Assembly: DataWeb.Core.dll
    Syntax
    public class ModuleSubscriberReport : ModuleReport

    Constructors

    ModuleSubscriberReport(Section, NavigationContext, IServiceProvider)

    Report module that exports newsletter subscribers to an Excel file.

    Declaration
    public ModuleSubscriberReport(Section section, NavigationContext navigationContext, IServiceProvider serviceProvider)
    Parameters
    Type Name Description
    Section section
    NavigationContext navigationContext
    IServiceProvider serviceProvider

    Methods

    GetReportNameAsync(Item, Dictionary<string, object>, CancellationToken)

    Retrieves the name of the report to be generated.

    Declaration
    public override Task<string> GetReportNameAsync(Item item, Dictionary<string, object> moduleData, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    Item item

    The item for which the report name is being retrieved.

    Dictionary<string, object> moduleData

    The data associated with the report generation.

    CancellationToken cancellationToken

    Token to cancel the asynchronous operation.

    Returns
    Type Description
    Task<string>

    A task that represents the asynchronous operation. The task result contains the name of the report file.

    Overrides
    ModuleReport.GetReportNameAsync(Item, Dictionary<string, object>, CancellationToken)

    ProcessReportAsync(Item, Dictionary<string, object>, CancellationToken)

    Processes the report and generates the report content as a stream.

    Declaration
    public override Task<Stream> ProcessReportAsync(Item item, Dictionary<string, object> moduleData, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    Item item

    The item for which the report is being generated.

    Dictionary<string, object> moduleData

    The data associated with the report generation.

    CancellationToken cancellationToken

    Token to cancel the asynchronous operation.

    Returns
    Type Description
    Task<Stream>

    A task that represents the asynchronous operation. The task result contains the report content as a stream.

    Overrides
    ModuleReport.ProcessReportAsync(Item, Dictionary<string, object>, CancellationToken)
    In this article
    Back to top Generated by DocFX