Class: VCardTime

Constructor

new VCardTime(data, zone, icaltype)

Creates a new ICAL.VCardTime instance.

Parameters:

Name Type Description

data

Object

The data for the time instance

Properties

Name	Type	Attributes	Description
`year`	Number	<optional>	The year for this date
`month`	Number	<optional>	The month for this date
`day`	Number	<optional>	The day for this date
`hour`	Number	<optional>	The hour for this date
`minute`	Number	<optional>	The minute for this date
`second`	Number	<optional>	The second for this date

zone

ICAL.Timezone | ICAL.UtcOffset

The timezone to use

icaltype

String

The type for this date/time object

Source: vcard_time.js, line 26

Extends

ICAL.Time

Members

(constant) DEFAULT_WEEK_START

The default weekday for the WKST part.

Overrides: ICAL.Time#DEFAULT_WEEK_START
Default Value: ICAL.Time.MONDAY
Source: time.js, line 378

day :Number

The day of this date.

Type:

Number

Overrides: ICAL.Time#day
Source: time.js, line 470

daysInYearPassedMonth :Array.<Array.<Number>>

The days that have passed in the year after a given month. The array has two members, one being an array of passed days for non-leap years, the other analog for leap years.

Type:

Array.<Array.<Number>>

Overrides: ICAL.Time#daysInYearPassedMonth
Source: time.js, line 360

Example

var isLeapYear = ICAL.Time.isLeapYear(year);
var passedDays = ICAL.Time.daysInYearPassedMonth[isLeapYear][month];

(constant) epochTime :ICAL.Time

January 1st, 1970 as an ICAL.Time.

Type:

ICAL.Time

Overrides: ICAL.Time#epochTime
Source: time.js, line 329

fromData

Creates a new ICAL.Time instance from the the passed data object.

Overrides: ICAL.Time#fromData
Source: time.js, line 258

hour :Number

The hour of this date-time.

Type:

Number

Overrides: ICAL.Time#hour
Source: time.js, line 482

(constant) icalclass :String

The class identifier.

Type:

String

Overrides: ICAL.Time#icalclass
Default Value: "vcardtime"
Source: vcard_time.js, line 95

icaltype :String

The type name, to be used in the jCal object.

Type:

String

Overrides: ICAL.Time#icaltype
Default Value: "date-and-or-time"
Source: vcard_time.js, line 102

isDate :Boolean

If true, the instance represents a date (as opposed to a date-time)

Type:

Boolean

Overrides: ICAL.Time#isDate
Source: time.js, line 518

minute :Number

The minute of this date-time.

Type:

Number

Overrides: ICAL.Time#minute
Source: time.js, line 494

month :Number

The month of this date.

Type:

Number

Overrides: ICAL.Time#month
Source: time.js, line 458

second :Number

The second of this date-time.

Type:

Number

Overrides: ICAL.Time#second
Source: time.js, line 506

year :Number

The year of this date.

Type:

Number

Overrides: ICAL.Time#year
Source: time.js, line 446

zone :ICAL.Timezone

The timezone for this time.

Type:

ICAL.Timezone

Overrides: ICAL.Time#zone
Source: time.js, line 430

Methods

addDuration(aDuration)

Adds the duration to the current time. The instance is modified in place.

Parameters:

Name	Type	Description
`aDuration`	ICAL.Duration	The duration to add

Overrides: ICAL.Time#addDuration
Source: time.js, line 1021

adjust(aExtraDays, aExtraHours, aExtraMinutes, aExtraSeconds, aTimeopt)

Adjust the date/time by the given offset

Parameters:

Name	Type	Attributes	Description
`aExtraDays`	Number		The extra amount of days
`aExtraHours`	Number		The extra amount of hours
`aExtraMinutes`	Number		The extra amount of minutes
`aExtraSeconds`	Number		The extra amount of seconds
`aTime`	Number	<optional>	The time to adjust, defaults to the current instance.

Overrides: ICAL.Time#adjust
Source: time.js, line 1221

clone() → {ICAL.VCardTime}

Returns a clone of the vcard date/time object.

Overrides: ICAL.Time#clone
Source: vcard_time.js, line 111

Returns:

The cloned object

Type:: ICAL.VCardTime

compare(aOther) → {Number}

Compares the ICAL.Time instance with another one, or a period.

Parameters:

Name	Type	Description
`aOther`	ICAL.Time \| ICAL.Period	The instance to compare with

Overrides: ICAL.Time#compare
Source: time.js, line 1079

Returns:

-1, 0 or 1 for less/equal/greater

Type:: Number

compareDateOnlyTz(other, tz) → {Number}

Compares only the date part of this instance with another one.

Parameters:

Name	Type	Description
`other`	ICAL.Time	The instance to compare with
`tz`	ICAL.Timezone	The timezone to compare in

Overrides: ICAL.Time#compareDateOnlyTz
Source: time.js, line 1099

Returns:

-1, 0 or 1 for less/equal/greater

Type:: Number

convertToZone(zone) → {ICAL.Time}

Convert the instance into another timezone. The returned ICAL.Time instance is always a copy.

Parameters:

Name	Type	Description
`zone`	ICAL.Timezone	The zone to convert to

Overrides: ICAL.Time#convertToZone
Source: time.js, line 1118

Returns:

The copy, converted to the zone

Type:: ICAL.Time

dayOfWeek(aWeekStartopt) → {ICAL.Time.weekDay}

Calculate the day of week.

Parameters:

Name	Type	Attributes	Description
`aWeekStart`	ICAL.Time.weekDay	<optional>	The week start weekday, defaults to SUNDAY

Overrides: ICAL.Time#dayOfWeek
Source: time.js, line 682

Returns:

Type:: ICAL.Time.weekDay

dayOfYear() → {Number}

Calculate the day of year.

Overrides: ICAL.Time#dayOfYear
Source: time.js, line 712

Returns:

Type:: Number

endOfMonth() → {ICAL.Time}

Returns a copy of the current date/time, shifted to the end of the month. The resulting ICAL.Time instance is of icaltype date, even if this is a date-time.

Overrides: ICAL.Time#endOfMonth
Source: time.js, line 782

Returns:

The end of the month (cloned)

Type:: ICAL.Time

endOfWeek(aWeekStartopt) → {ICAL.Time}

Returns a copy of the current date/time, shifted to the end of the week. The resulting ICAL.Time instance is of icaltype date, even if this is a date-time.

Parameters:

Name	Type	Attributes	Description
`aWeekStart`	ICAL.Time.weekDay	<optional>	The week start weekday, defaults to SUNDAY

Overrides: ICAL.Time#endOfWeek
Source: time.js, line 747

Returns:

The end of the week (cloned)

Type:: ICAL.Time

endOfYear() → {ICAL.Time}

Returns a copy of the current date/time, shifted to the end of the year. The resulting ICAL.Time instance is of icaltype date, even if this is a date-time.

Overrides: ICAL.Time#endOfYear
Source: time.js, line 817

Returns:

The end of the year (cloned)

Type:: ICAL.Time

fromJSDate(aDatenullable, useUTCopt)

Set up the current instance from the Javascript date value.

Parameters:

Name	Type	Attributes	Default	Description
`aDate`	Date	<nullable>		The Javascript Date to read, or null to reset
`useUTC`	Boolean	<optional>	false	If true, the UTC values of the date will be used

Overrides: ICAL.Time#fromJSDate
Source: time.js, line 605

fromUnixTime(seconds)

Sets up the current instance from unix time, the number of seconds since January 1st, 1970.

Parameters:

Name	Type	Description
`seconds`	Number	The seconds to set up with

Overrides: ICAL.Time#fromUnixTime
Source: time.js, line 1313

getDominicalLetter(yr) → {String}

Get the dominical letter for the current year. Letters range from A - G for common years, and AG to GF for leap years.

Parameters:

Name	Type	Description
`yr`	Number	The year to retrieve the letter for

Overrides: ICAL.Time#getDominicalLetter
Source: time.js, line 850

Returns:

The dominical letter.

Type:: String

isNthWeekDay(aDayOfWeek, aPos) → {Boolean}

Checks if current time is the nth weekday, relative to the current month. Will always return false when rule resolves outside of current month.

Parameters:

Name	Type	Description
`aDayOfWeek`	ICAL.Time.weekDay	Day of week to check
`aPos`	Number	Relative position

Overrides: ICAL.Time#isNthWeekDay
Source: time.js, line 950

Returns:

True, if it is the nth weekday

Type:: Boolean

nthWeekDay(aDayOfWeek, aPos) → {Number}

Finds the nthWeekDay relative to the current month (not day). The returned value is a day relative the month that this month belongs to so 1 would indicate the first of the month and 40 would indicate a day in the following month.

Parameters:

Name	Type	Description
`aDayOfWeek`	Number	Day of the week see the day name constants
`aPos`	Number	Nth occurrence of a given week day values of 1 and 0 both indicate the first weekday of that type. aPos may be either positive or negative

Overrides: ICAL.Time#nthWeekDay
Source: time.js, line 868

Returns:

numeric value indicating a day relative to the current month of this time object

Type:: Number

reset()

Reset the time instance to epoch time

Overrides: ICAL.Time#reset
Source: time.js, line 571

resetTo(year, month, day, hour, minute, second, timezone)

Reset the time instance to the given date/time values.

Parameters:

Name	Type	Description
`year`	Number	The year to set
`month`	Number	The month to set
`day`	Number	The day to set
`hour`	Number	The hour to set
`minute`	Number	The minute to set
`second`	Number	The second to set
`timezone`	ICAL.Timezone	The timezone to set

Overrides: ICAL.Time#resetTo
Source: time.js, line 587

startDoyWeek(aFirstDayOfWeekopt) → {Number}

First calculates the start of the week, then returns the day of year for this date. If the day falls into the previous year, the day is zero or negative.

Parameters:

Name	Type	Attributes	Description
`aFirstDayOfWeek`	ICAL.Time.weekDay	<optional>	The week start weekday, defaults to SUNDAY

Overrides: ICAL.Time#startDoyWeek
Source: time.js, line 836

Returns:

The calculated day of year

Type:: Number

startOfMonth() → {ICAL.Time}

Returns a copy of the current date/time, rewound to the start of the month. The resulting ICAL.Time instance is of icaltype date, even if this is a date-time.

Overrides: ICAL.Time#startOfMonth
Source: time.js, line 765

Returns:

The start of the month (cloned)

Type:: ICAL.Time

startOfWeek(aWeekStartopt) → {ICAL.Time}

Returns a copy of the current date/time, rewound to the start of the week. The resulting ICAL.Time instance is of icaltype date, even if this is a date-time.

Parameters:

Name	Type	Attributes	Description
`aWeekStart`	ICAL.Time.weekDay	<optional>	The week start weekday, defaults to SUNDAY

Overrides: ICAL.Time#startOfWeek
Source: time.js, line 727

Returns:

The start of the week (cloned)

Type:: ICAL.Time

startOfYear() → {ICAL.Time}

Returns a copy of the current date/time, rewound to the start of the year. The resulting ICAL.Time instance is of icaltype date, even if this is a date-time.

Overrides: ICAL.Time#startOfYear
Source: time.js, line 799

Returns:

The start of the year (cloned)

Type:: ICAL.Time

subtractDate(aDate) → {ICAL.Duration}

Subtract the date details (excluding timezone). Useful for finding the relative difference between two time objects excluding their timezone differences.

Parameters:

Name	Type	Description
`aDate`	ICAL.Time	The date to subtract

Overrides: ICAL.Time#subtractDate
Source: time.js, line 1055

Returns:

The difference as a duration

Type:: ICAL.Duration

subtractDateTz(aDate) → {ICAL.Duration}

Subtract the date details, taking timezones into account.

Parameters:

Name	Type	Description
`aDate`	ICAL.Time	The date to subtract

Overrides: ICAL.Time#subtractDateTz
Source: time.js, line 1067

Returns:

The difference in duration

Type:: ICAL.Duration

toICALString() → {String}

Returns an RFC 6350 compliant representation of this object.

Overrides: ICAL.Time#toICALString
Source: vcard_time.js, line 135

Returns:

vcard date/time string

Type:: String

toJSDate() → {Date}

Converts the current instance to a Javascript date

Overrides: ICAL.Time#toJSDate
Source: time.js, line 1187

Returns:

Type:: Date

toJSON() → {Object}

Converts time to into Object which can be serialized then re-created using the constructor.

Overrides: ICAL.Time#toJSON
Source: time.js, line 1376

Returns:

Type:: Object

Example

// toJSON will automatically be called
var json = JSON.stringify(mytime);

var deserialized = JSON.parse(json);

var time = new ICAL.Time(deserialized);

toString() → {String}

The string representation of this date/time, in jCard form (including : and - separators).

Overrides: ICAL.Time#toString
Source: vcard_time.js, line 144

Returns:

Type:: String

toUnixTime() → {Number}

Converts the current instance to seconds since January 1st 1970.

Overrides: ICAL.Time#toUnixTime
Source: time.js, line 1340

Returns:

Seconds since 1970

Type:: Number

utcOffset() → {Number}

Calculates the UTC offset of the current date/time in the timezone it is in.

Overrides: ICAL.Time#utcOffset
Source: time.js, line 1136

Returns:

UTC offset in seconds

Type:: Number

weekNumber(aWeekStart) → {Number}

Calculates the ISO 8601 week number. The first week of a year is the week that contains the first Thursday. The year can have 53 weeks, if January 1st is a Friday.

Note there are regions where the first week of the year is the one that starts on January 1st, which may offset the week number. Also, if a different week start is specified, this will also affect the week number.

Parameters:

Name	Type	Description
`aWeekStart`	ICAL.Time.weekDay	The weekday the week starts with

Overrides: ICAL.Time#weekNumber
Source: time.js, line 981
See: Time.weekOneStarts

Returns:

The ISO week number

Type:: Number

(static) fromDateAndOrTimeString(aValue, aIcalType) → {ICAL.VCardTime}

Returns a new ICAL.VCardTime instance from a date and/or time string.

Parameters:

Name	Type	Description
`aValue`	String	The string to create from
`aIcalType`	String	The type for this instance, e.g. date-and-or-time

Source: vcard_time.js, line 34

Returns:

The date/time instance

Type:: ICAL.VCardTime