InstantiateFiltersRequest InstantiateFiltersRequest InstantiateFiltersRequest InstantiateFiltersRequest Class

Definition

Contains the data that is needed to instantiate a set of filters for Dynamics 365 for Outlook for the specified user.

For the Web API use the InstantiateFilters Action.

public ref class InstantiateFiltersRequest sealed : Microsoft::Xrm::Sdk::OrganizationRequest
[System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class InstantiateFiltersRequest : Microsoft.Xrm.Sdk.OrganizationRequest
type InstantiateFiltersRequest = class
    inherit OrganizationRequest
Public NotInheritable Class InstantiateFiltersRequest
Inherits OrganizationRequest
Inheritance
InstantiateFiltersRequestInstantiateFiltersRequestInstantiateFiltersRequestInstantiateFiltersRequest
Attributes

Examples


// Call InstantiateFiltersRequest
         Console.WriteLine("Retrieving user's ID and creating the template collection");
          var whoAmI = new WhoAmIRequest();
          Guid id = ((WhoAmIResponse)svc.Execute(whoAmI)).UserId;

var templates = new EntityReferenceCollection();
       templates.Add(new EntityReference(SavedQuery.EntityLogicalName, _offlineTemplate));
Console.WriteLine("Activating the selected offline templates for this user");

var request = new InstantiateFiltersRequest
{
    UserId = id,
    TemplateCollection = templates                            
};
var response =
    (InstantiateFiltersResponse)svc.Execute(request);
Console.WriteLine();

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.

Outlook#RetrieveDataFilters2 OutlookVB#RetrieveDataFilters2

Remarks

Message Availability

For this message to work, the caller must be connected to the server.

Usage

Pass an instance of this class to the Execute(OrganizationRequest) method, which returns an instance of InstantiateFiltersResponse.

Privileges and Access Rights

To perform this action, the caller must have privileges on the UserQuery entity and access rights on the records specified in the TemplateCollection property. For a complete list of the privileges required, see InstantiateFilters message privileges.

Notes for Callers

This creates a user query record for the specified user for each filter specified in the TemplateCollection property.

Constructors

InstantiateFiltersRequest() InstantiateFiltersRequest() InstantiateFiltersRequest() InstantiateFiltersRequest()

Initializes a new instance of theInstantiateFiltersRequest class.

Properties

ExtensionData ExtensionData ExtensionData ExtensionData

Gets or sets the structure that contains extra data. Optional.

(Inherited from OrganizationRequest)
Item[String] Item[String] Item[String] Item[String]

Gets or sets the indexer for the Parameters collection.

(Inherited from OrganizationRequest)
Parameters Parameters Parameters Parameters

Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.

(Inherited from OrganizationRequest)
RequestId RequestId RequestId RequestId

Gets or sets the ID of an asynchronous operation (system job). Optional.

(Inherited from OrganizationRequest)
RequestName RequestName RequestName RequestName

Gets or sets the name of the request. Required, but is supplied by derived classes.

(Inherited from OrganizationRequest)
TemplateCollection TemplateCollection TemplateCollection TemplateCollection

Gets or sets the set of filters to instantiate for the user.

UserId UserId UserId UserId

Gets or sets the ID of the user that will own the user query records created.

Applies to

See also