Class NewsletterRecordAdminController

Inheritance
object
ControllerBase
AbpControllerBase
CmsKitProAdminController
NewsletterRecordAdminController
Implements
Inherited Members
Namespace: Volo.CmsKit.Admin.Newsletters
Assembly: Volo.CmsKit.Pro.Admin.HttpApi.dll
Syntax
[RequiresFeature(new string[] { "CmsKitPro.NewsletterEnable" })]
[RequiresGlobalFeature(typeof(NewslettersFeature))]
[RemoteService(true, Name = "CmsKitAdmin")]
[Area("cms-kit-pro-admin")]
[Route("api/cms-kit-admin/newsletter")]
[Authorize("CmsKit.Newsletter")]
public class NewsletterRecordAdminController : CmsKitProAdminController, IAvoidDuplicateCrossCuttingConcerns, INewsletterRecordAdminAppService, IApplicationService, IRemoteService

Constructors

NewsletterRecordAdminController(INewsletterRecordAdminAppService)

Declaration
public NewsletterRecordAdminController(INewsletterRecordAdminAppService newsletterRecordAdminAppService)
Parameters
Type Name Description
INewsletterRecordAdminAppService newsletterRecordAdminAppService

Properties

NewsletterRecordAdminAppService

Declaration
protected INewsletterRecordAdminAppService NewsletterRecordAdminAppService { get; }
Property Value
Type Description
INewsletterRecordAdminAppService

Methods

GetAsync(Guid)

Declaration
[HttpGet]
[Route("{id}")]
public Task<NewsletterRecordWithDetailsDto> GetAsync(Guid id)
Parameters
Type Name Description
Guid id
Returns
Type Description
Task<NewsletterRecordWithDetailsDto>

GetCsvResponsesAsync(GetNewsletterRecordsCsvRequestInput)

Declaration
[HttpGet]
[Route("export-csv")]
[AllowAnonymous]
public virtual Task<IRemoteStreamContent> GetCsvResponsesAsync(GetNewsletterRecordsCsvRequestInput input)
Parameters
Type Name Description
GetNewsletterRecordsCsvRequestInput input
Returns
Type Description
Task<IRemoteStreamContent>

GetDownloadTokenAsync()

Declaration
[HttpGet]
[Route("download-token")]
public Task<DownloadTokenResultDto> GetDownloadTokenAsync()
Returns
Type Description
Task<DownloadTokenResultDto>

GetImportInvalidNewslettersFileAsync(GetImportInvalidNewslettersFileInput)

Declaration
[HttpGet]
[Route("download-import-invalid-newsletters-file")]
[AllowAnonymous]
public Task<IRemoteStreamContent> GetImportInvalidNewslettersFileAsync(GetImportInvalidNewslettersFileInput input)
Parameters
Type Name Description
GetImportInvalidNewslettersFileInput input
Returns
Type Description
Task<IRemoteStreamContent>

GetImportNewslettersSampleFileAsync(GetImportNewslettersSampleFileInput)

Declaration
[HttpGet]
[Route("import-newsletters-sample-file")]
[AllowAnonymous]
public Task<IRemoteStreamContent> GetImportNewslettersSampleFileAsync(GetImportNewslettersSampleFileInput input)
Parameters
Type Name Description
GetImportNewslettersSampleFileInput input
Returns
Type Description
Task<IRemoteStreamContent>

GetListAsync(GetNewsletterRecordsRequestInput)

Declaration
[HttpGet]
public Task<PagedResultDto<NewsletterRecordDto>> GetListAsync(GetNewsletterRecordsRequestInput input)
Parameters
Type Name Description
GetNewsletterRecordsRequestInput input
Returns
Type Description
Task<PagedResultDto<NewsletterRecordDto>>

GetNewsletterPreferencesAsync()

Declaration
[HttpGet]
[Route("preferences")]
public Task<List<string>> GetNewsletterPreferencesAsync()
Returns
Type Description
Task<List<string>>

GetNewsletterPreferencesAsync(string)

Declaration
[HttpGet]
[Route("preferences/{emailAddress}")]
public Task<List<NewsletterPreferenceDetailsDto>> GetNewsletterPreferencesAsync(string emailAddress)
Parameters
Type Name Description
string emailAddress
Returns
Type Description
Task<List<NewsletterPreferenceDetailsDto>>

GetNewsletterRecordsCsvDetailAsync(GetNewsletterRecordsCsvRequestInput)

Declaration
[HttpGet]
[Route("csv-detail")]
public Task<List<NewsletterRecordCsvDto>> GetNewsletterRecordsCsvDetailAsync(GetNewsletterRecordsCsvRequestInput input)
Parameters
Type Name Description
GetNewsletterRecordsCsvRequestInput input
Returns
Type Description
Task<List<NewsletterRecordCsvDto>>

ImportNewslettersFromFileAsync(ImportNewslettersFromFileInputWithStream)

Declaration
[HttpPost]
[Route("import-newsletters-from-file")]
public Task<ImportNewslettersFromFileOutput> ImportNewslettersFromFileAsync(ImportNewslettersFromFileInputWithStream input)
Parameters
Type Name Description
ImportNewslettersFromFileInputWithStream input
Returns
Type Description
Task<ImportNewslettersFromFileOutput>

UpdatePreferencesAsync(UpdatePreferenceInput)

Declaration
[HttpPut]
[Route("preferences")]
public Task UpdatePreferencesAsync(UpdatePreferenceInput input)
Parameters
Type Name Description
UpdatePreferenceInput input
Returns
Type Description
Task

Implements

Extension Methods