SalienceCollection.GetUserEntities

<< SalienceCollection.GetConceptTopics | Back to Salience 6 .Net Index | SalienceAttribute >>

Summary

Returns the user-defined entities from the collection. This is based on the entity list specified through the User Entity List option. Other adjustments can be made through the available Collection Options, which must be set before this call is made.
The id parameter is an optional parameter to specify which configuration to return results for. Content can be processed by multiple configurations in one pass by prior calls to Salience.AddSalienceConfiguration. Omitting this parameter or passing an empty string returns results based on the default configuration.
This method is a a wrapper around the underlying C API method lxaGetCollectionUserEntities.

Syntax

public List<SalienceCollectionEntity> GetUserEntities(String id="")

Parameters

id Optional: The identifier for a specific configuration for results.

Returns

If successful, a List<> of SalienceCollectionEntity objects is returned. Otherwise, an exception is thrown with information about the failure.

Example

TODO: Example needed for Salience 6

<< SalienceCollection.GetConceptTopics | Back to Salience 6 .Net Index | SalienceAttribute >>