Click or drag to resize

IDataExportService Methods

The IDataExportService type exposes the following members.

Methods
  NameDescription
Public methodAllowExport
Determines if the service is set up to allow export in the given AppContext.
Public methodAuditMessage(IAppContext)
Gets the Audit message to use during the export process.
Public methodAuditMessage(IExtension)
Gets the Audit message to use during the export process.
Public methodAuditMessageNoCount(IAppContext)
Gets the Audit message (With no count) to use during the export process.
Public methodAuditMessageNoCount(IExtension)
Gets the Audit message (With no count) to use during the export process.
Public methodClone
Creates a new object that is a copy of the current instance.
(Inherited from ICloneable.)
Public methodConvert(String)
Converts a given file, or XML, to the default file extension of the Service.
Public methodConvert(String, Boolean)
Converts a given file to the default file extnsion of the Service. When set, the original exported files will be deleted.
Public methodConvert(String, String, IMapper)
Converts a given file, or XML, to the specified file extension.
Public methodConvertToStream
Converts a given set of XML to a filestream with the given file extension.
Public methodExec
The Exec method provides extended functionality.
(Inherited from IEAPBase.)
Public methodExport(IMapper, MapperExportOptions)
Performs the export of all records. Note that the mapper is assumed to be filtered correctly.
Public methodExport(IMapper, MapperExportOptions, Int32, String)
Performs the export. Note that the mapper is assumed to be filtered correctly.
Public methodGetMIMEType
Gets the MIME type for a given file extension.
Public methodOnWebhook
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.)
Public methodServiceLoaded
Called after the ServiceInfo object is loaded
(Inherited from IServiceInfo.)
Top
See Also