SearchByTitleKbArticleRequest Class

Artículo
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 search for knowledge base articles that contain the specified title.

For the Web API use the SearchByTitleKbArticle Function.

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.SearchByTitleKbArticleRequest

Syntax

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

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

Constructors

	Name	Description
	SearchByTitleKbArticleRequest()	Initializes a new instance of the SearchByTitleKbArticleRequest 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 base articles with the specified title. 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 title in the articles. Required.
	SubjectId	Gets or sets the ID of the subject for the knowledge base article. Required.
	UseInflection	Gets or sets a value that indicates whether to use inflectional stem matching when you search for knowledge base articles by a specific title. 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 the Execute method, which returns an instance of the SearchByTitleKbArticleResponse class.

Privileges and Access Rights

To perform this action, the caller must have privileges on the KbArticle and Subject entities. The caller must also have access rights on the specified record in the SubjectId property and on the records that are returned from the query. For a complete list of the required privileges, see SearchByTitleKbArticle message privileges.

Notes for Callers

This message supports queries that use a query expression and FetchXML. For more information, see Retrieve data with queries using SDK assemblies.

Examples

The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an IOrganizationService interface. For the complete sample, see the link later in this topic.



// create the request
SearchByTitleKbArticleRequest searchByTitleRequest = 
    new SearchByTitleKbArticleRequest()
{
    SubjectId = _subjectId,
    UseInflection = false,
    SearchText = "code",
    QueryExpression = new QueryExpression()
    {
        ColumnSet = new ColumnSet("title"),
        EntityName = KbArticle.EntityLogicalName
    }
};

// execute the request
Console.WriteLine();
Console.WriteLine("  Searching for published articles with 'code' in the title");
var searchByTitleResponse = (SearchByTitleKbArticleResponse)
    _context.Execute(searchByTitleRequest);

// check success
var retrievedArticles = searchByTitleResponse.EntityCollection.Entities
    .Select((entity) => (KbArticle)entity);
Console.WriteLine("  Results of search (titles found):");
foreach (var article in retrievedArticles)
    Console.WriteLine(article.Title);

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.

Compartir a través de