Class: Property

Constructor

new Property(jCal, parentopt)

Creates a new ICAL.Property instance.

It is important to note that mutations done in the wrapper directly mutate the jCal object used to initialize.

Can also be used to create new properties by passing the name of the property (as a String).

Parameters:

Name	Type	Attributes	Description
`jCal`	Array \| String		Raw jCal representation OR the new name of the property
`parent`	ICAL.Component	<optional>	Parent component

Source: property.js, line 54

Members

name :String

The name of this property, in lowercase.

Type:

String

Source: property.js, line 102

parent :ICAL.Component

The parent component for this property.

Type:

ICAL.Component

Source: property.js, line 110

type :String

The value type for this property

Type:

String

Source: property.js, line 94

Methods

getDefaultType() → {String}

Get the default type based on this property's name.

Source: property.js, line 296

Returns:

The default type for this property

Type:: String

getFirstParameter(name) → {String}

Gets first parameter on the property.

Parameters:

Name	Type	Description
`name`	String	Parameter name (lowercase)

Source: property.js, line 256

Returns:

Parameter value

Type:: String

getFirstValue() → {ICAL.Binary|ICAL.Duration|ICAL.Period|ICAL.Recur|ICAL.Time|ICAL.UtcOffset|Geo|string|null}

Finds the first property value.

Source: property.js, line 327

Returns:

First property value

Type:: ICAL.Binary | ICAL.Duration | ICAL.Period | ICAL.Recur | ICAL.Time | ICAL.UtcOffset | Geo | string | null

getParameter(name) → {Array|String}

Gets a parameter on the property.

Parameters:

Name	Type	Description
`name`	String	Parameter name (lowercase)

Source: property.js, line 242

Returns:

Parameter value

Type:: Array | String

getValues() → {Array}

Gets all values on the property.

NOTE: this creates an array during each call.

Source: property.js, line 338

Returns:

List of values

Type:: Array

removeAllValues()

Removes all values from this property

Source: property.js, line 359

removeParameter(name)

Removes a parameter

Parameters:

Name	Type	Description
`name`	String	The parameter name

Source: property.js, line 287

resetType(type)

Sets type of property and clears out any existing values of the current type.

Parameters:

Name	Type	Description
`type`	String	New iCAL type (see design.*.values)

Source: property.js, line 315

setParameter(name, value)

Sets a parameter on the property.

Parameters:

Name	Type	Description
`name`	String	The parameter name
`value`	Array \| String	The parameter value

Source: property.js, line 272

setValue(value)

Sets the current value of the property. If this is a multi-value property, all other values will be removed.

Parameters:

Name	Type	Description
`value`	String \| Object	New property value.

Source: property.js, line 407

setValues(values)

Sets the values of the property. Will overwrite the existing values. This can only be used for multi-value properties.

Parameters:

Name	Type	Description
`values`	Array	An array of values

Source: property.js, line 372

toICALString() → {String}

The string representation of this component.

Source: property.js, line 433

Returns:

Type:: String

toJSON() → {Object}

Returns the Object representation of this component. The returned object is a live jCal object and should be cloned if modified.

Source: property.js, line 425

Returns:

Type:: Object

(static) fromString(str, designSetopt) → {ICAL.Property}

Create an ICAL.Property by parsing the passed iCalendar string.

Parameters:

Name	Type	Attributes	Description
`str`	String		The iCalendar string to parse
`designSet`	ICAL.design.designSet	<optional>	The design data to use for this property

Source: property.js, line 62

Returns:

The created iCalendar property

Type:: ICAL.Property