#import <kfxKLOServerExtractor.h>
Instance Methods | |
| (instancetype) | - initWithConnection: |
| Constructor for custom request provider. More... | |
| (void) | - extract: |
| Use this method to start extraction. More... | |
| (void) | - cancelExtraction |
| Use this method to cancel the extraction. More... | |
Properties | |
| id< KFXServerExtractorDelegate > | delegate |
| KFXServerExtractorDelegate notifies about extraction completion. More... | |
Method Documentation
| - (void) cancelExtraction |
Use this method to cancel the extraction.
If this method is called during the extraction, extractionResults:error: method of the KFXServerExtractorDelegate will be called, containing NSError object which represent cancel extraction error.If there is no error it will be nil.When the callback is received, you may start new extraction.
If new extraction is started before receiving extractionResult callback, the behavior is undefined.
- See also
- KFXServerExtractorDelegate
| - (void) extract: | (KFXServerExtractionParameters *) | parameters |
Use this method to start extraction.
This method starts the extraction with specified extraction parameters. Parameters will be verified before the extraction. In case of invalid parameters an appropriate error will be returned via delegate.
- Parameters
-
parameters - a KFXServerExtractionParameters object with extraction parameters.
| - (instancetype) initWithConnection: | (id< KFXServerConnectionProtocol >) | requestProvider |
Constructor for custom request provider.
This constructor allows to specify custom request provider to be used to get extraction results.
- Parameters
-
requestProvider - a request provider instance which conforms to KFXServerConnectionProtocol protocol.
- See also
- KFXServerConnectionProtocol
Property Documentation
|
readwritenonatomicweak |
KFXServerExtractorDelegate notifies about extraction completion.
This delegate must be set in order for your app to receive delegate calls.
- See also
- KFXServerExtractorDelegate
The documentation for this class was generated from the following file: