Class SearchDocumentToDelete

The document that will be deleted from search Index.

Inheritance
System.Object
SearchDocumentToDelete
SearchDocument
Namespace: DotNetNuke.Services.Search.Entities
Assembly: DotNetNuke.dll
Syntax
public class SearchDocumentToDelete : object
Remarks

This is the base for all search documents (have common properties) that can be used for deleting from the search index.

Constructors

| Improve this Doc View Source

SearchDocumentToDelete()

Initializes a new instance of the SearchDocumentToDelete class.

Declaration
public SearchDocumentToDelete()
Remarks

This is the base for all search documents (have common properties) that can be used for deleting from the search index.

Properties

| Improve this Doc View Source

AuthorUserId

Gets or sets user Id of the Author.

Declaration
public int AuthorUserId { get; set; }
Property Value
Type Description
System.Int32
Remarks

Author's display name is automatically found and stored. AuthorName can be found in SearchResult. However, this may get out of date if Display Name is changed after Index.

| Improve this Doc View Source

CultureCode

Gets or sets culture Code associated with the content.

Declaration
public string CultureCode { get; set; }
Property Value
Type Description
System.String
Remarks

A value of NULL/EMPTY means this is property is not used.

| Improve this Doc View Source

Keywords

Gets or sets additional keywords can be specified for Indexing.

Declaration
public IDictionary<string, string> Keywords { get; set; }
Property Value
Type Description
IDictionary<System.String, System.String>
Remarks

This is key-value pair, e.g. "AliasName","something".

| Improve this Doc View Source

ModuleDefId

Gets or sets module Definition Id of the Content.

Declaration
public int ModuleDefId { get; set; }
Property Value
Type Description
System.Int32
Remarks

This is needed when SearchTypeId is for a Module.

| Improve this Doc View Source

ModuleId

Gets or sets module Id of the Content.

Declaration
public int ModuleId { get; set; }
Property Value
Type Description
System.Int32
Remarks

This is needed when SearchTypeId is for a Module.

| Improve this Doc View Source

NumericKeys

Gets or sets additional numeric fields can be specified for Indexing.

Declaration
public IDictionary<string, int> NumericKeys { get; set; }
Property Value
Type Description
IDictionary<System.String, System.Int32>
Remarks

This is key-value pair, e.g. "ItemId","888".

| Improve this Doc View Source

PortalId

Gets or sets portal Id.

Declaration
public int PortalId { get; set; }
Property Value
Type Description
System.Int32
Remarks

A value of -1 means this is property is not used.

| Improve this Doc View Source

QueryString

Gets or sets queryString that may be associated with a Search Document.

Declaration
public string QueryString { get; set; }
Property Value
Type Description
System.String
Remarks

This information will be used to create Url for the document.

| Improve this Doc View Source

RoleId

Gets or sets roleId (GroupId) for additional filtering [Optional].

Declaration
public int RoleId { get; set; }
Property Value
Type Description
System.Int32
Remarks

This property can be used while under Social Groups.

| Improve this Doc View Source

SearchTypeId

Gets or sets search Type Id, e.g. module, file or url.

Declaration
public int SearchTypeId { get; set; }
Property Value
Type Description
System.Int32
Remarks

A value of -1 means this is property is not used.

| Improve this Doc View Source

TabId

Gets or sets tab Id of the Content [Optional].

Declaration
public int TabId { get; set; }
Property Value
Type Description
System.Int32
Remarks

A value of -1 means this is property is not used.

| Improve this Doc View Source

UniqueKey

Gets or sets a key to uniquely identify a document in the Index.

Declaration
public string UniqueKey { get; set; }
Property Value
Type Description
System.String
Remarks

A value of -1 means this is property is not used.

Methods

| Improve this Doc View Source

ToJsonString()

This is to allow saving current instance into DB as JSON entity.

Declaration
public string ToJsonString()
Returns
Type Description
System.String

A JSON string.
Remarks

This is the base for all search documents (have common properties) that can be used for deleting from the search index.

| Improve this Doc View Source

ToString()

The document that will be deleted from search Index.

Declaration
public override string ToString()
Returns
Type Description
System.String
Remarks

This is overriden to present current instance as JSON string.

Extension Methods