ResetUserFiltersRequest Class

 

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

Contains the data that is needed to reset the offline data filters for the calling user to the default filters for the organization.

For the Web API use the ResetUserFilters 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.ResetUserFiltersRequest

Syntax

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

Constructors

Name Description
System_CAPS_pubmethod ResetUserFiltersRequest()

Initializes a new instance of theResetUserFiltersRequest 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 QueryType

Gets or sets the type of filters to set. Required.

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

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

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

Privileges and Access Rights

For a complete list of the privileges required, see ResetUserFilters message privileges.

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 ResetUserFiltersRequest
Console.WriteLine("Resetting the user's offline templates to the defaults");
ResetUserFiltersRequest resetRequest = new ResetUserFiltersRequest
{
    QueryType = SavedQueryQueryType.OfflineFilters
};
ResetUserFiltersResponse resetResponse =
    (ResetUserFiltersResponse)_serviceProxy.Execute(resetRequest);
Console.WriteLine();


' Call ResetUserFiltersRequest
Console.WriteLine("Resetting the user's offline templates to the defaults")
Dim resetRequest As ResetUserFiltersRequest = New ResetUserFiltersRequest With {.QueryType = SavedQueryQueryType.OfflineFilters}
Dim resetResponse As ResetUserFiltersResponse = CType(_serviceProxy.Execute(resetRequest), ResetUserFiltersResponse)
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

ResetUserFiltersResponse
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