FullTextSearchKnowledgeArticleRequest Class

Articolo
11/28/2016

Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

Contains the data that is needed to perform a full-text search on knowledge articles in CRM using the specified search text.

For the Web API use the FullTextSearchKnowledgeArticle Action.

Web API support for this message was added with December 2016 update for Microsoft Dynamics 365 (online) and December 2016 Service Pack for Microsoft Dynamics 365 (on-premises) .

Namespace: Microsoft.Crm.Sdk.Messages
Assembly: Microsoft.Crm.Sdk.Proxy (in Microsoft.Crm.Sdk.Proxy.dll)

Inheritance Hierarchy

System.Object
Microsoft.Xrm.Sdk.OrganizationRequest
Microsoft.Crm.Sdk.Messages.FullTextSearchKnowledgeArticleRequest

Syntax

[DataContractAttribute(Namespace = "https://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class FullTextSearchKnowledgeArticleRequest : OrganizationRequest

<DataContractAttribute(Namespace := "https://schemas.microsoft.com/crm/2011/Contracts")>
Public NotInheritable Class FullTextSearchKnowledgeArticleRequest
    Inherits OrganizationRequest

Constructors

	Name	Description
	FullTextSearchKnowledgeArticleRequest()	Initializes a new instance of FullTextSearchKnowledgeArticleRequest class.

Properties

	Name	Description
	ExtensionData	Gets or sets the structure that contains extra data. Optional.(Inherited from OrganizationRequest.)
	Item[String]	Gets or sets the indexer for the Parameters collection.(Inherited from OrganizationRequest.)
	Parameters	Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)
	QueryExpression	Gets or sets the query criteria to find knowledge articles with specified text. Required.
	RemoveDuplicates	Gets or sets a value that indicates whether to remove multiple versions of the same knowledge article in search results. Required.
	RequestId	Gets or sets the ID of an asynchronous operation (system job). Optional. (Inherited from OrganizationRequest.)
	RequestName	Gets or sets the name of the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)
	SearchText	Gets or sets the text to search for in knowledge articles. Required.
	StateCode	Gets or sets the state of the knowledge articles to filter the search results. Required.
	UseInflection	Gets or sets a value that indicates whether to use inflectional stem matching when searching for knowledge articles. Required.

Methods

	Name	Description
	Equals(Object)	(Inherited from Object.)
	GetHashCode()	(Inherited from Object.)
	GetType()	(Inherited from Object.)
	ToString()	(Inherited from Object.)

Remarks

Message Availability

This message works regardless whether the caller is connected to the server or offline.

Usage

Pass an instance of this class to theExecute method, which returns an instance of FullTextSearchKnowledgeArticleResponse.

Privileges and Access Rights

To perform this action, the caller must have privileges on the KnowledgeArticle entity. For a complete list of required privileges, see FullTextSearchKnowledgeArticle message privileges.

Notes for Callers

This message supports queries using FetchXML and QueryExpression. For more information, see Build queries with FetchXML and Build queries with QueryExpression.

Some of the filtering is done post-search from the full-text index, which depends on the values specified for the StateCode and RemoveDuplicates parameters. For information about the rules based on these parameters, see StateCode and RemoveDuplicates.

Thread Safety

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Condividi tramite