Share via


EntitySearchRequest Class

 

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

Contains the data that is needed to create a request object for reusing an existing Entity Search definition in Unified Service Desk.

Namespace:   Microsoft.Crm.UnifiedServiceDesk.Dynamics.EntitySearch
Assembly:  Microsoft.Crm.UnifiedServiceDesk.Dynamics (in Microsoft.Crm.UnifiedServiceDesk.Dynamics.dll)

Inheritance Hierarchy

System.Object
  Microsoft.Crm.UnifiedServiceDesk.Dynamics.EntitySearch.EntitySearchRequest

Syntax

public class EntitySearchRequest
Public Class EntitySearchRequest

Constructors

Name Description
System_CAPS_pubmethod EntitySearchRequest(String)

System_CAPS_pubmethod EntitySearchRequest(String, Int32)

Initializes a new instance of the EntitySearchRequest class using the entity search name and maximum count of records to be returned.

System_CAPS_pubmethod EntitySearchRequest(String, Int32, Int32, String)

Initializes a new instance of the EntitySearchRequest class using the using the entity search name, page count, page number, and paging cookie.

Properties

Name Description
System_CAPS_pubproperty EntityName

Gets the entity name that the search applies to.

System_CAPS_pubproperty IsMultiPaged

Gets whether the search results contain multiple pages.

System_CAPS_pubproperty MaxCount

Gets the maximum count of the records to be returned.

System_CAPS_pubproperty PageCookie

Gets the current paging information.

System_CAPS_pubproperty PageCount

Gets the number of records to return per page.

System_CAPS_pubproperty PageNumber

Gets the page number of the result set to return the data.

Methods

Name Description
System_CAPS_pubmethod Equals(Object)

(Inherited from Object.)

System_CAPS_protmethod Finalize()

(Inherited from Object.)

System_CAPS_pubmethod GetHashCode()

(Inherited from Object.)

System_CAPS_pubmethod GetType()

(Inherited from Object.)

System_CAPS_protmethod MemberwiseClone()

(Inherited from Object.)

System_CAPS_pubmethod ToString()

(Inherited from Object.)

Remarks

You must use one of the constructors to create a request object depending how you want the records to be returned. Creating a request object directly without using one of these three constructors is not supported.

Before using an entity search name in the request object, ensure that the entity search is already defined in Unified Service Desk on your CRM instance.

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.

See Also

Microsoft.Crm.UnifiedServiceDesk.Dynamics.EntitySearch Namespace
Search data using entity searches in Unified Service Desk
Reuse Entity Search definition in your custom code

Return to top

Unified Service Desk 2.0

© 2017 Microsoft. All rights reserved. Copyright