SearchIndexDocument is defined in the Telligent.Evolution.Extensibility.Api.Entities.Version1 namespace.
Definition
class SearchIndexDocument : ApiEntity, IApiEntity
{
SearchIndexDocument();
SearchIndexDocument(AdditionalInfo info);
SearchIndexDocument(Guid contentId, Guid contentTypeId);
Single Boost { get; set; }
string Content { get; set; }
Guid ContentId { get; set; }
Guid ContentTypeId { get; set; }
IList<Error> Errors { get; }
string Id { get; set; }
IList<IndexField> IndexFields { get; set; }
string Title { get; set; }
string TypeName { get; set; }
string Url { get; set; }
IList<Warning> Warnings { get; }
void AddField(string fieldName, string fieldValue);
bool HasErrors();
bool HasWarnings();
bool HasWarningsOrErrors();
void RemoveField(IndexField field);
void ThrowErrors();
}
Constructors
SearchIndexDocument();
SearchIndexDocument(AdditionalInfo info);
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| info | AdditionalInfo | Info | Required |
SearchIndexDocument(Guid contentId, Guid contentTypeId);
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| contentId | Guid | Content Id | Required | ||
| contentTypeId | Guid | Content Type Id | Required |
Properties
| Name | Type | Description | Default | Options |
|---|---|---|---|---|
| Boost | Single | |||
| Content | string | |||
| ContentId | Guid | |||
| ContentTypeId | Guid | |||
| Errors | IList<Error> | |||
| Id | string | |||
| IndexFields | IList<IndexField> | |||
| Title | string | |||
| TypeName | string | |||
| Url | string | |||
| Warnings | IList<Warning> |
Methods
void AddField(string fieldName, string fieldValue);
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| fieldName | string | Field Name | Required | ||
| fieldValue | string | Field Value | Required |
bool HasErrors();
Return Type
bool HasWarnings();
Return Type
bool HasWarningsOrErrors();
Return Type
void RemoveField(IndexField field);
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| field | IndexField | Field | Required |