Value

class Value(**properties: Any)

Superclasses: Object, Object

This is the ICalValue instance.

Constructors

class Value

classmethod new(kind: ValueKind) → Value

Creates a new Value with specific kind.

Added in version 1.0.

Parameters:

kind – A ValueKind

classmethod new_action(v: PropertyAction) → Value

Creates a new Value with the type action.

Added in version 1.0.

Parameters:

v – The action value

classmethod new_attach(v: Attach) → Value

Creates a new Value with the type attach.

Added in version 1.0.

Parameters:

v – The attach value

classmethod new_binary(v: str) → Value

Creates a new Value with the type binary.

Added in version 1.0.

Parameters:

v – The binary value

classmethod new_boolean(v: int) → Value

Creates a new Value with the type boolean.

Added in version 1.0.

Parameters:

v – The boolean value

classmethod new_busytype(v: PropertyBusytype) → Value

Creates a new Value with the type busytype.

Added in version 2.0.

Parameters:

v – The busytype value

classmethod new_caladdress(v: str) → Value

Creates a new Value with the type caladdress.

Added in version 1.0.

Parameters:

v – The caladdress value

classmethod new_carlevel(v: PropertyCarlevel) → Value

Creates a new Value with the type carlevel.

Added in version 1.0.

Parameters:

v – The carlevel value

classmethod new_class(v: Property_Class) → Value

Creates a new Value with the type class.

Added in version 1.0.

Parameters:

v – The class value

classmethod new_cmd(v: PropertyCmd) → Value

Creates a new Value with the type cmd.

Added in version 1.0.

Parameters:

v – The cmd value

classmethod new_date(v: Time) → Value

Creates a new Value with the type date.

Added in version 1.0.

Parameters:

v – The date value

classmethod new_datetime(v: Time) → Value

Creates a new Value with the type datetime.

Added in version 1.0.

Parameters:

v – The datetime value

classmethod new_datetimedate(v: Time) → Value

Creates a new Value with the type datetimedate (DATE-TIME or DATE).

Added in version 3.0.

Parameters:

v – The DATE-TIME or DATE value

classmethod new_datetimeperiod(v: Datetimeperiod) → Value

Creates a new Value with the type datetimeperiod.

Added in version 1.0.

Parameters:

v – The datetimeperiod value

classmethod new_duration(v: Duration) → Value

Creates a new Value with the type duration.

Added in version 1.0.

Parameters:

v – The duration value

classmethod new_float(v: float) → Value

Creates a new Value with the type float.

Added in version 1.0.

Parameters:

v – The float value

classmethod new_from_string(kind: ValueKind, str: str) → Value

Creates a new Value based on the ValueKind and a string.

Added in version 1.0.

Parameters:

• kind – A ValueKind

• str – A string

classmethod new_geo(v: Geo) → Value

Creates a new Value with the type geo.

Added in version 1.0.

Parameters:

v – The geo value

classmethod new_integer(v: int) → Value

Creates a new Value with the type integer.

Added in version 1.0.

Parameters:

v – The integer value

classmethod new_method(v: PropertyMethod) → Value

Creates a new Value with the type method.

Added in version 1.0.

Parameters:

v – The method value

classmethod new_period(v: Period) → Value

Creates a new Value with the type period.

Added in version 1.0.

Parameters:

v – The period value

classmethod new_pollcompletion(v: PropertyPollcompletion) → Value

Creates a new Value with the type pollcompletion.

Added in version 2.0.

Parameters:

v – The pollcompletion value

classmethod new_pollmode(v: PropertyPollmode) → Value

Creates a new Value with the type pollmode.

Added in version 2.0.

Parameters:

v – The pollmode value

classmethod new_query(v: str) → Value

Creates a new Value with the type query.

Added in version 1.0.

Parameters:

v – The query value

classmethod new_querylevel(v: PropertyQuerylevel) → Value

Creates a new Value with the type querylevel.

Added in version 1.0.

Parameters:

v – The querylevel value

classmethod new_recur(v: Recurrence) → Value

Creates a new Value with the type recur.

Added in version 1.0.

Parameters:

v – The recur value

classmethod new_requeststatus(v: Reqstat) → Value

Creates a new Value with the type requeststatus.

Added in version 1.0.

Parameters:

v – The requeststatus value

classmethod new_status(v: PropertyStatus) → Value

Creates a new Value with the type status.

Added in version 1.0.

Parameters:

v – The status value

classmethod new_string(v: str) → Value

Creates a new Value with the type string.

Added in version 1.0.

Parameters:

v – The string value

classmethod new_taskmode(v: PropertyTaskmode) → Value

Creates a new Value with the type taskmode.

Added in version 2.0.

Parameters:

v – The taskmode value

classmethod new_text(v: str) → Value

Creates a new Value with the type text.

Added in version 1.0.

Parameters:

v – The text value

classmethod new_transp(v: PropertyTransp) → Value

Creates a new Value with the type transp.

Added in version 1.0.

Parameters:

v – The transp value

classmethod new_trigger(v: Trigger) → Value

Creates a new Value with the type trigger.

Added in version 1.0.

Parameters:

v – The trigger value

classmethod new_uri(v: str) → Value

Creates a new Value with the type uri.

Added in version 1.0.

Parameters:

v – The uri value

classmethod new_utcoffset(v: int) → Value

Creates a new Value with the type utcoffset.

Added in version 1.0.

Parameters:

v – The utcoffset value

classmethod new_x(v: str) → Value

Creates a new Value with the type x.

Added in version 1.0.

Parameters:

v – The x value

classmethod new_xlicclass(v: PropertyXlicclass) → Value

Creates a new Value with the type xlicclass.

Added in version 1.0.

Parameters:

v – The xlicclass value

Methods

class Value

as_ical_string() → str

Converts the Value to a string.

Added in version 1.0.

clone() → Value

Deeply clone a Value.

Added in version 1.0.

compare(b: Value) → ParameterXliccomparetype

Compares two Value.

Added in version 1.0.

Parameters:

b – A Value

classmethod decode_ical_string() → str | None

Extracts the original character string encoded by the above function.

Added in version 1.0.

classmethod encode_ical_string() → str | None

Encodes a character string in ical format, escape certain characters, etc.

Added in version 1.0.

get_action() → PropertyAction

Gets the action of Value.

Added in version 1.0.

get_attach() → Attach | None

Gets the attach of Value.

Added in version 1.0.

get_binary() → str | None

Gets the binary of Value.

Added in version 1.0.

get_boolean() → int

Gets the boolean of Value.

Added in version 1.0.

get_busytype() → PropertyBusytype

Gets the busytype of Value.

Added in version 2.0.

get_caladdress() → str | None

Gets the caladdress of Value.

Added in version 1.0.

get_carlevel() → PropertyCarlevel

Gets the carlevel of Value.

Added in version 1.0.

get_class() → Property_Class

Gets the class of Value.

Added in version 1.0.

get_cmd() → PropertyCmd

Gets the cmd of Value.

Added in version 1.0.

get_date() → Time | None

Gets the date of Value.

Added in version 1.0.

get_datetime() → Time | None

Gets the datetime of Value.

Added in version 1.0.

get_datetimedate() → Time | None

Gets the datetimedate (DATE-TIME or DATE) of Value.

Added in version 3.0.

get_datetimeperiod() → Datetimeperiod | None

Gets the datetimeperiod of Value.

Added in version 1.0.

get_duration() → Duration | None

Gets the duration of Value.

Added in version 1.0.

get_float() → float

Gets the float of Value.

Added in version 1.0.

get_geo() → Geo | None

Gets the geo of Value.

Added in version 1.0.

get_integer() → int

Gets the integer of Value.

Added in version 1.0.

get_method() → PropertyMethod

Gets the method of Value.

Added in version 1.0.

get_parent() → Property | None

Gets the parent Property of the specified Value.

Added in version 3.0.

get_period() → Period | None

Gets the period of Value.

Added in version 1.0.

get_pollcompletion() → PropertyPollcompletion

Gets the pollcompletion of Value.

Added in version 2.0.

get_pollmode() → PropertyPollmode

Gets the pollmode of Value.

Added in version 2.0.

get_query() → str | None

Gets the query of Value.

Added in version 1.0.

get_querylevel() → PropertyQuerylevel

Gets the querylevel of Value.

Added in version 1.0.

get_recur() → Recurrence | None

Gets the recur of Value.

Added in version 1.0.

get_requeststatus() → Reqstat | None

Gets the requeststatus of Value.

Added in version 1.0.

get_status() → PropertyStatus

Gets the status of Value.

Added in version 1.0.

get_string() → str | None

Gets the string of Value.

Added in version 1.0.

get_taskmode() → PropertyTaskmode

Gets the taskmode of Value.

Added in version 2.0.

get_text() → str | None

Gets the text of Value.

Added in version 1.0.

get_transp() → PropertyTransp

Gets the transp of Value.

Added in version 1.0.

get_trigger() → Trigger | None

Gets the trigger of Value.

Added in version 1.0.

get_uri() → str | None

Gets the uri of Value.

Added in version 1.0.

get_utcoffset() → int

Gets the utcoffset of Value.

Added in version 1.0.

get_x() → str | None

Gets the x of Value.

Added in version 1.0.

get_xlicclass() → PropertyXlicclass

Gets the xlicclass of Value.

Added in version 1.0.

is_valid() → bool

Checks if Value is valid.

Added in version 1.0.

isa() → ValueKind

Gets the kind of Value.

Added in version 1.0.

isa_value() → int

Checks whether the native part of Value is an icalvalue.

Added in version 1.0.

classmethod kind_from_string() → ValueKind

Converts a string to ValueKind.

Added in version 1.0.

classmethod kind_is_valid() → bool

Checks whether the ValueKind is valid.

Added in version 1.0.

classmethod kind_to_property_kind() → PropertyKind

Converts a ValueKind to a PropertyKind.

Added in version 1.0.

classmethod kind_to_string() → str

Converts the ValueKind to a string.

Added in version 1.0.

reset_kind() → None

Resets the kind of Value.

Added in version 1.0.

set_action(v: PropertyAction) → None

Sets the action in the Value.

Added in version 1.0.

Parameters:

v – The action value

set_attach(v: Attach) → None

Sets the attach in the Value.

Added in version 1.0.

Parameters:

v – The attach value

set_binary(v: str) → None

Sets the binary in the Value.

Added in version 1.0.

Parameters:

v – The binary value

set_boolean(v: int) → None

Sets the boolean in the Value.

Added in version 1.0.

Parameters:

v – The boolean value

set_busytype(v: PropertyBusytype) → None

Sets the busytype in the Value.

Added in version 2.0.

Parameters:

v – The busytype value

set_caladdress(v: str) → None

Sets the caladdress in the Value.

Added in version 1.0.

Parameters:

v – The caladdress value

set_carlevel(v: PropertyCarlevel) → None

Sets the carlevel in the Value.

Added in version 1.0.

Parameters:

v – The carlevel value

set_class(v: Property_Class) → None

Sets the class in the Value.

Added in version 1.0.

Parameters:

v – The class value

set_cmd(v: PropertyCmd) → None

Sets the cmd in the Value.

Added in version 1.0.

Parameters:

v – The cmd value

set_date(v: Time) → None

Sets the date in the Value.

Added in version 1.0.

Parameters:

v – The date value

set_datetime(v: Time) → None

Sets the datetime in the Value.

Added in version 1.0.

Parameters:

v – The datetime value

set_datetimedate(v: Time) → None

Sets the datetimedate (DATE-TIME or DATE) in the Value.

Added in version 3.0.

Parameters:

v – The datetimedate (DATE-TIME or DATE) value

set_datetimeperiod(v: Datetimeperiod) → None

Sets the datetimeperiod in the Value.

Added in version 1.0.

Parameters:

v – The datetimeperiod value

set_duration(v: Duration) → None

Sets the duration in the Value.

Added in version 1.0.

Parameters:

v – The duration value

set_float(v: float) → None

Sets the float in the Value.

Added in version 1.0.

Parameters:

v – The float value

set_geo(v: Geo) → None

Sets the geo in the Value.

Added in version 1.0.

Parameters:

v – The geo value

set_integer(v: int) → None

Sets the integer in the Value.

Added in version 1.0.

Parameters:

v – The integer value

set_method(v: PropertyMethod) → None

Sets the method in the Value.

Added in version 1.0.

Parameters:

v – The method value

set_parent(property: Property | None = None) → None

Sets the parent property of a value.

Added in version 2.0.

Parameters:

property – The parent Property

set_period(v: Period) → None

Sets the period in the Value.

Added in version 1.0.

Parameters:

v – The period value

set_pollcompletion(v: PropertyPollcompletion) → None

Sets the pollcompletion in the Value.

Added in version 2.0.

Parameters:

v – The pollcompletion value

set_pollmode(v: PropertyPollmode) → None

Sets the pollmode in the Value.

Added in version 2.0.

Parameters:

v – The pollmode value

set_query(v: str) → None

Sets the query in the Value.

Added in version 1.0.

Parameters:

v – The query value

set_querylevel(v: PropertyQuerylevel) → None

Sets the querylevel in the Value.

Added in version 1.0.

Parameters:

v – The querylevel value

set_recur(v: Recurrence) → None

Sets the recur in the Value.

Added in version 1.0.

Parameters:

v – The recur value

set_requeststatus(v: Reqstat) → None

Sets the requeststatus in the Value.

Added in version 1.0.

Parameters:

v – The requeststatus value

set_status(v: PropertyStatus) → None

Sets the status in the Value.

Added in version 1.0.

Parameters:

v – The status value

set_string(v: str) → None

Sets the string in the Value.

Added in version 1.0.

Parameters:

v – The string value

set_taskmode(v: PropertyTaskmode) → None

Sets the taskmode in the Value.

Added in version 2.0.

Parameters:

v – The taskmode value

set_text(v: str) → None

Sets the text in the Value.

Added in version 1.0.

Parameters:

v – The text value

set_transp(v: PropertyTransp) → None

Sets the transp in the Value.

Added in version 1.0.

Parameters:

v – The transp value

set_trigger(v: Trigger) → None

Sets the trigger in the Value.

Added in version 1.0.

Parameters:

v – The trigger value

set_uri(v: str) → None

Sets the uri in the Value.

Added in version 1.0.

Parameters:

v – The uri value

set_utcoffset(v: int) → None

Sets the utcoffset in the Value.

Added in version 1.0.

Parameters:

v – The utcoffset value

set_x(v: str) → None

Sets the x in the Value.

Added in version 1.0.

Parameters:

v – The x value

set_xlicclass(v: PropertyXlicclass) → None

Sets the xlicclass in the Value.

Added in version 1.0.

Parameters:

v – The xlicclass value