ConvertDateAndTimeBehaviorRequest Class

 

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

Contains the data to convert existing UTC date and time values in the database to DateOnly values.

Namespace:   Microsoft.Xrm.Sdk.Messages
Assembly:  Microsoft.Xrm.Sdk (in Microsoft.Xrm.Sdk.dll)

Inheritance Hierarchy

System.Object
  Microsoft.Xrm.Sdk.OrganizationRequest
    Microsoft.Xrm.Sdk.Messages.ConvertDateAndTimeBehaviorRequest

Syntax

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

Constructors

Name Description
System_CAPS_pubmethod ConvertDateAndTimeBehaviorRequest()

Initializes a new instance of the ConvertDateAndTimeBehaviorRequest class.

Properties

Name Description
System_CAPS_pubproperty Attributes

Gets or sets a collection of entity and attributes to apply the behavior conversion on. Required

System_CAPS_pubproperty AutoConvert

Gets or sets whether to automatically convert to DateOnly value, if possible. Optional.

System_CAPS_pubproperty ConversionRule

Gets or sets the conversion rule to apply. Required.

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 TimeZoneCode

Gets or sets the CRM time zone code to be used for the conversion. Required only if SpecificTimeZone is specified in ConversionRule parameter.

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 the Execute method, which returns an instance of the ConvertDateAndTimeBehaviorResponse class.

Privileges and Access Rights

To perform this action, the caller must have the System Administrator role.

Notes to Caller

This message is available for Microsoft Dynamics CRM Online 2015 Update 1 only.

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.


ConvertDateAndTimeBehaviorRequest request = new ConvertDateAndTimeBehaviorRequest()
{
    Attributes = new EntityAttributeCollection() 
            { 
                new KeyValuePair<string, StringCollection>("account", new StringCollection() 
                { "new_sampledatetimeattribute" }) 
            },
    ConversionRule = DateTimeBehaviorConversionRule.SpecificTimeZone.Value,
    TimeZoneCode = 190, // Time zone code for India Standard Time (IST) in CRM
    AutoConvert = false // Conversion must be done using ConversionRule
};

// Execute the request
ConvertDateAndTimeBehaviorResponse response = (ConvertDateAndTimeBehaviorResponse)_serviceProxy.Execute(request);

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.Xrm.Sdk.Messages Namespace
Behavior and format of the date and time attribute
Sample: Convert date and time behavior

Return to top

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright