External Agent COM API Reference Guide › API Interfaces: Applying Policy and Generating CA DataMinder Events › COM Object: WGNRDILib::WgnActiveImportConnector › Interface IWgnActiveImportConnector › Method ImportObjectAsync

Method ImportObjectAsync

This method supplies a message to CA DataMinder to be analyzed against policy asynchronously.

Note: Synchronous calls are covered by the ImportObject() method.

HRESULT ImportObjectAsync(
    [in]         WGN_IMPORTOBJ_TYPE         objectType,
    [in]         WGN_IMPORTOBJ_FORMAT       objectFormat,
    [in]         WGN_IMPORTOBJ_TRANSPORT    objectTransport,
    [in]         VARIANT                    objectData,
    [in, unique] LPOLESTR                   messageId,  // OPTIONAL
    [in]         DWORD                      importSource,
    [in, unique] LPOLESTR                   xmlMessageAttributes,  // OPTIONAL
    [in]         DWORD                      eventSizeHintBytes,
    [in]         BOOL                       allowDeferredCompletion,
    [in, unique] LPvoid                     contextTag,
    [in]         IWgnImportConnectorCallback  *asyncCallback
    );

Where:

objectType

Specifies the type of object to import (e-mail or IM). For details, see the typedef WGN_IMPORTOBJ_TYPE.

objectFormat

Specifies the format of the object to import. For details, see the typedef WGN_IMPORTOBJ_FORMAT.

objectTransport

Specifies the method used to transfer data to the External Agent. For details, see the typedef WGN_IMPORTOBJ_TRANSPORT.

objectData

Specifies the source data being imported.

messageID

Is a string that specifies the unique identifier of the message within the archive.

This parameter is optional. It can be NULL if no link is to be made to a remote archive or if allowDeferredCompletion is TRUE, in which case the client will supply the messageID when committing the transaction.

This parameter must be set to NULL if and only if the importSource parameter is set to WGN_ACTIVEIMPORTSOURCE_NONE.

importSource

Is a fixed integer that identifies the source archive. If there is no link to a remote archive, it is WGN_ACTIVEIMPORTSOURCE_NONE.

xmlMessageAttributes

Optional XML containing additional metadata for the message.

eventSizeHintBytes

Specifies an average message size (in bytes). The hub uses this value to estimate the total size of the various hub event queues. (Hub throttling is based either on the total size or the total event count for all hub event queues).

allowDeferredCompletion

See ImportObject()method.

contextTag

This parameter allows the caller to supply contextual data to this asynchronous operation. The WgnActiveImportConnector will transparently pass this through to the callback via the IWgnImportConnectorCallback interface. If deferred completion is used, this value is not automatically passed through to the callback for a CommitAsync() operation. To achieve this, the caller must supply the value to the CommitAsync() method.

asyncCallback

An interface to an object hosted by the caller through which WgnActiveImportConnector will inform the caller of the results from processing the message.

More information:

Synchronous Versus Asynchronous Operations

Single-pass Processing Versus Deferred Completion

Specification for XmlMessageAttribute Data

Values for importSource