Constructor
new UtcOffset(aData)
Creates a new ICAL.UtcOffset instance.
| Name | Type | Description | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
aData | Object | An object with members of the utc offset Properties
|
- Source
Members
factor :Number
The sign of the utc offset, 1 for positive offset, -1 for negative offsets.
- Number
- Source
hours :Number
The hours in the utc-offset
- Number
- Source
(constant) icaltype :String
The type name, to be used in the jCal object.
- String
- Default Value
- "utc-offset"
- Source
minutes :Number
The minutes in the utc-offset
- Number
- Source
Methods
clone() → {ICAL.UtcOffset}
Returns a clone of the utc offset object.
- Source
The cloned object
- Type:
- ICAL.
UtcOffset
compare(other) → {Number}
Compare this utc offset with another one.
| Name | Type | Description |
|---|---|---|
other | ICAL. | The other offset to compare with |
- Source
-1, 0 or 1 for less/equal/greater
- Type:
- Number
fromData(aData)
Sets up the current instance using members from the passed data object.
| Name | Type | Description | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
aData | Object | An object with members of the utc offset Properties
|
- Source
fromSeconds(aSeconds)
Sets up the current instance from the given seconds value. The seconds value is truncated to the minute. Offsets are wrapped when the world ends, the hour after UTC+14:00 is UTC-12:00.
| Name | Type | Description |
|---|---|---|
aSeconds | Number | The seconds to convert into an offset |
- Source
toICALString() → {String}
The iCalendar string representation of this utc-offset.
- Source
- Type:
- String
toSeconds() → {Number}
Convert the current offset to a value in seconds
- Source
The offset in seconds
- Type:
- Number
toString() → {String}
The string representation of this utc-offset.
- Source
- Type:
- String
(static) fromSeconds(aSeconds)
Creates a new ICAL.UtcOffset instance from the passed seconds value.
| Name | Type | Description |
|---|---|---|
aSeconds | Number | The number of seconds to convert |
- Source
(static) fromString(aString) → {ICAL.Duration}
Creates a new ICAL.UtcOffset instance from the passed string.
| Name | Type | Description |
|---|---|---|
aString | String | The string to parse |
- Source
The created utc-offset instance
- Type:
- ICAL.
Duration