RelativeDate.dateId

Note:

The content in this help topic pertains to SuiteScript 2.0.

Property Description

The date ID of the relative date.

For relative dates that you create using query.createRelativeDate(options), the value of this property is set when that method is executed. For relative dates that are included in the query.RelativeDateRange enum, the value of this property is always available (for example, query.RelativeDateRange.YESTERDAY.dateId).

This property uses values from the query.DateId enum.

Type

string (read-only)

Module

N/query Module

Parent Object

query.RelativeDate

Sibling Object Members

RelativeDate Object Members

Since

2019.1

Syntax

Important:

The following code sample shows the syntax for this member. It is not a functional example. For a complete script example, see N/query Module Script Samples.

            // Add additional code
...
var myRelativeDate = query.createRelativeDate({ dateId: query.DateId.WEEKS_AGO, value: 2
}); var theDateId = myRelativeDate.dateId;
...
// Add additional code 

          

Related Topics

query.Query
N/query Module
SuiteScript 2.x Modules
SuiteScript 2.x

General Notices