Class ExportSelectionToFileBatchPlugin

Inheritance
object
BatchTaskBase
ExportSelectionToFileBatchPlugin
Implements
Inherited Members
Namespace: SuperOffice.CRM.BatchProcessing.Plugins
Assembly: SoBatchProcessing.dll
Syntax
[BatchTask("ExportSelectionToFileBatchPlugin", ManualCleanup = true)]
public class ExportSelectionToFileBatchPlugin : BatchTaskBase, IBatchTask

Constructors

ExportSelectionToFileBatchPlugin(IBatchData, IBatchServiceConfiguration, ILogger<ExportSelectionToFileBatchPlugin>, ISelectionTypeManager)

Declaration
public ExportSelectionToFileBatchPlugin(IBatchData batchData, ConfigFile.IBatchServiceConfiguration batchServiceConfiguration, ILogger<ExportSelectionToFileBatchPlugin> logger, ISelectionTypeManager selectionTypeManager)
Parameters
Type Name Description
IBatchData batchData
ConfigFile.IBatchServiceConfiguration batchServiceConfiguration
ILogger<ExportSelectionToFileBatchPlugin> logger
ISelectionTypeManager selectionTypeManager

Fields

PluginName

Declaration
public const string PluginName = "ExportSelectionToFileBatchPlugin"
Field Value
Type Description
string

Methods

ExportSelectionMembersEnumeratorAsync(int, string, string, int, bool, string, CancellationToken)

Iterate through the selection members and yield every line back to the caller.

Declaration
public IAsyncEnumerable<string> ExportSelectionMembersEnumeratorAsync(int selectionId, string templateName, string cultureName, int targetTableNumber, bool useContacts, string orderBy = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int selectionId
string templateName
string cultureName

Not in use
int targetTableNumber
bool useContacts
string orderBy
CancellationToken cancellationToken
Returns
Type Description
IAsyncEnumerable<string>

RunAsync(string, string, CancellationToken)

Run the task.

Declaration
protected override Task<bool> RunAsync(string name, string context, CancellationToken cancellationToken = default)
Parameters
Type Name Description
string name

Name of the task.
string context

Context for the task.
CancellationToken cancellationToken
Returns
Type Description
Task<bool>

True if the task succeeded.
Overrides
Remarks

Call SetResult(string) as needed.

Implements

Extension Methods