Jaa


InstantiateFiltersRequest Class

 

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

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.

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

Syntax

[DataContractAttribute(Namespace = "https://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class InstantiateFiltersRequest : OrganizationRequest
<DataContractAttribute(Namespace := "https://schemas.microsoft.com/crm/2011/Contracts")>
Public NotInheritable Class InstantiateFiltersRequest
    Inherits OrganizationRequest

Constructors

Name Description
System_CAPS_pubmethod InstantiateFiltersRequest()

Initializes a new instance of theInstantiateFiltersRequest class.

Properties

Name Description
System_CAPS_pubproperty ExtensionData

Gets or sets the structure that contains extra data. Optional.(Inherited from OrganizationRequest.)

System_CAPS_pubproperty Item[String]

Gets or sets the indexer for the Parameters collection.(Inherited from OrganizationRequest.)

System_CAPS_pubproperty Parameters

Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)

System_CAPS_pubproperty RequestId

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

System_CAPS_pubproperty RequestName

Gets or sets the name of the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)

System_CAPS_pubproperty TemplateCollection

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

System_CAPS_pubproperty UserId

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

Methods

Name Description
System_CAPS_pubmethod Equals(Object)

(Inherited from Object.)

System_CAPS_pubmethod GetHashCode()

(Inherited from Object.)

System_CAPS_pubmethod GetType()

(Inherited from Object.)

System_CAPS_pubmethod ToString()

(Inherited from Object.)

Remarks

Message Availability

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

Usage

Pass an instance of this class to theExecute 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.

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.



// Call InstantiateFiltersRequest
Console.WriteLine("Retrieving user's ID and creating the template collection");
WhoAmIRequest whoAmI = new WhoAmIRequest();
Guid id = ((WhoAmIResponse)_serviceProxy.Execute(whoAmI)).UserId;
EntityReferenceCollection templates = new EntityReferenceCollection();
templates.Add(new EntityReference(
    SavedQuery.EntityLogicalName,
    _offlineTemplate));

Console.WriteLine("Activating the selected offline templates for this user");
InstantiateFiltersRequest request = new InstantiateFiltersRequest
{
    UserId = id,
    TemplateCollection = templates                            
};
InstantiateFiltersResponse response =
    (InstantiateFiltersResponse)_serviceProxy.Execute(request);
Console.WriteLine();


' Call InstantiateFiltersRequest
Console.WriteLine("Retrieving user's ID and creating the template collection")
Dim whoAmI As New WhoAmIRequest()
Dim id As Guid = (CType(_serviceProxy.Execute(whoAmI), WhoAmIResponse)).UserId
Dim templates As New EntityReferenceCollection()
templates.Add(New EntityReference(SavedQuery.EntityLogicalName, _offlineTemplate))

Console.WriteLine("Activating the selected offline templates for this user")
Dim request As InstantiateFiltersRequest = New InstantiateFiltersRequest With {.UserId = id, .TemplateCollection = templates}
Dim response As InstantiateFiltersResponse = CType(_serviceProxy.Execute(request), InstantiateFiltersResponse)
Console.WriteLine()

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

InstantiateFiltersResponse
Microsoft.Crm.Sdk.Messages Namespace
Offline and Outlook filters and templates
Sample: Create and retrieve Outlook filters

Return to top

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright