IDataExportService Interface |
An interface used by the DataExport set of processes to export a Mapper's set of data to a specific Data format.
The format specified is determined by the Service itself.
Namespace: NetQuarry.Services
Assembly: EAP.Core (in EAP.Core.dll) Version: 2.0.0.0 (4.6.8.0)
SyntaxThe IDataExportService type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | Application |
Gets or Sets the IAppContext object for the service.
(Inherited from IServiceInfo.) |
| Attributes | Gets/Sets the service attributes. (Inherited from IServiceInfo.) |
| Category | Gets/Sets the service category. (Inherited from IServiceInfo.) |
| CommandInfos |
A list of MapperCommand items processed by this Service.
|
| ComponentID | Gets/Sets the service ComponentID. (Inherited from IServiceInfo.) |
| DefaultFileExtension | The Default File Extension to use when exporting. |
| DefaultMIMEType | The Default MIME type to use when saving / pushing the file to the browser. |
| ID | Gets/Sets the service ID. (Inherited from IServiceInfo.) |
| IsLegacy | If true, then we intend to use this service in its original, Excel-only, implementation. |
| MapPropExportRowCount | The name of the property, on the Mapper, that contains the Row Count of the exported items. |
| Name | Gets/Sets the service name. (Inherited from IServiceInfo.) |
| Properties |
The Properties collection of Property objects for this object.
(Inherited from IEAPBase.) |
| TextItems | (Inherited from IEAPBase.) |
| Type | Gets/Sets the service type. (Inherited from IServiceInfo.) |
| Version |
Gets/sets the version of this object's assembly.
(Inherited from IEAPBase.) |
Methods| Name | Description | |
|---|---|---|
 | AllowExport |
Determines if the service is set up to allow export in the given AppContext.
|
| AuditMessage(IAppContext) |
Gets the Audit message to use during the export process.
|
| AuditMessage(IExtension) |
Gets the Audit message to use during the export process.
|
| AuditMessageNoCount(IAppContext) |
Gets the Audit message (With no count) to use during the export process.
|
| AuditMessageNoCount(IExtension) |
Gets the Audit message (With no count) to use during the export process.
|
| Clone | Creates a new object that is a copy of the current instance. (Inherited from ICloneable.) |
| Convert(String) |
Converts a given file, or XML, to the default file extension of the Service.
|
| Convert(String, Boolean) |
Converts a given file to the default file extnsion of the Service. When set, the original exported files will be deleted.
|
| Convert(String, String, IMapper) |
Converts a given file, or XML, to the specified file extension.
|
| ConvertToStream |
Converts a given set of XML to a filestream with the given file extension.
|
| Exec |
The Exec method provides extended functionality.
(Inherited from IEAPBase.) |
| Export(IMapper, MapperExportOptions) |
Performs the export of all records. Note that the mapper is assumed to be filtered correctly.
|
| Export(IMapper, MapperExportOptions, Int32, String) |
Performs the export. Note that the mapper is assumed to be filtered correctly.
|
| GetMIMEType |
Gets the MIME type for a given file extension.
|
| OnWebhook |
Handles an invocation of a "webhook" event for the service.
You should implement this event if you want your service to handle webhooks through the standard platform webhook wiring.
The raw wiring for the webhook would look like handler.ashx?req=webhook&service=sss&appkey=aaa&token=ttt where sss is
the name of the service, aaa is the application key, and ttt is the authentication token.
When wired up in the manner, the platform will instantiate an IAppContext object, authenticate the request based on
the provided token, obtain an instance of the service from the Services collection, and invoke this
method on the service.
If the webhook is wired up in this manner, you must override the base implementation of this method or an exception will be thrown.
(Inherited from IServiceInfo.) |
| ServiceLoaded |
Called after the ServiceInfo object is loaded
(Inherited from IServiceInfo.) |
See Also