Property

class Property(**properties: Any)

Superclasses: Object, Object

This is the ICalProperty instance.

Constructors

class Property

classmethod new(kind: PropertyKind) → Property

Creates a Property of the target type.

Added in version 1.0.

Parameters:

kind – The kind of Property to be created

classmethod new_acceptresponse(v: str) → Property

Creates a new Property.

Added in version 2.0.

Parameters:

v – The acceptresponse

classmethod new_acknowledged(v: Time) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The time of acknowledgement

classmethod new_action(v: PropertyAction) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The action

classmethod new_allowconflict(v: str) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The allowconflict

classmethod new_attach(v: Attach) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The Attach

classmethod new_attendee(v: str) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The attendee

classmethod new_busytype(v: PropertyBusytype) → Property

Creates a new Property.

Added in version 2.0.

Parameters:

v – The busytype

classmethod new_calid(v: str) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The calid

classmethod new_calmaster(v: str) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The calmaster

classmethod new_calscale(v: str) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The calscale

classmethod new_capversion(v: str) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The capversion

classmethod new_carid(v: str) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The carid

classmethod new_carlevel(v: PropertyCarlevel) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The carlevel

classmethod new_categories(v: str) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The categories

classmethod new_class(v: Property_Class) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The class

classmethod new_cmd(v: PropertyCmd) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The cmd

classmethod new_color(v: str) → Property

Creates a new color Property.

Added in version 1.0.

Parameters:

v – The color

classmethod new_comment(v: str) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The comment

classmethod new_completed(v: Time) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The time of completed

classmethod new_components(v: str) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The components

classmethod new_contact(v: str) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The contact

classmethod new_created(v: Time) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The time of created

classmethod new_csid(v: str) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The csid

classmethod new_datemax(v: Time) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The time of datemax

classmethod new_datemin(v: Time) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The time of datemin

classmethod new_decreed(v: str) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The decreed

classmethod new_defaultcharset(v: str) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The defaultcharset

classmethod new_defaultlocale(v: str) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The defaultlocale

classmethod new_defaulttzid(v: str) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The defaulttzid

classmethod new_defaultvcars(v: str) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The defaultvcars

classmethod new_deny(v: str) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The deny

classmethod new_description(v: str) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The description

classmethod new_dtend(v: Time) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The time of dtend

classmethod new_dtstamp(v: Time) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The time of dtstamp

classmethod new_dtstart(v: Time) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The time of dtstart

classmethod new_due(v: Time) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The time of due

classmethod new_duration(v: Duration) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The duration

classmethod new_estimatedduration(v: Duration) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The estimatedduration

classmethod new_exdate(v: Time) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The time of exdate

classmethod new_expand(v: int) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The expand

classmethod new_exrule(v: Recurrence) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The exrule recurrence type

classmethod new_freebusy(v: Period) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The freebusy period type

classmethod new_from_string(str: str) → Property

Creates a Property from a string.

Added in version 1.0.

Parameters:

str – The string used to construct a Property

classmethod new_geo(v: Geo) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The geo type

classmethod new_grant(v: str) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The grant

classmethod new_itipversion(v: str) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The itipversion

classmethod new_lastmodified(v: Time) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The time of lastmodified

classmethod new_location(v: str) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The location

classmethod new_maxcomponentsize(v: int) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The maxcomponentsize

classmethod new_maxdate(v: Time) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The time of maxdate

classmethod new_maxresults(v: int) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The maxresults

classmethod new_maxresultssize(v: int) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The maxresultssize

classmethod new_method(v: PropertyMethod) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The method

classmethod new_mindate(v: Time) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The time of mindate

classmethod new_multipart(v: str) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The multipart

classmethod new_name(v: str) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The name

classmethod new_organizer(v: str) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The organizer

classmethod new_owner(v: str) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The owner

classmethod new_percentcomplete(v: int) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The percentcomplete

classmethod new_permission(v: str) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The permission

classmethod new_pollcompletion(v: PropertyPollcompletion) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The pollcompletion

classmethod new_pollitemid(v: int) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The pollitemid

classmethod new_pollmode(v: PropertyPollmode) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The pollmode

classmethod new_pollproperties(v: str) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The pollproperties

classmethod new_pollwinner(v: int) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The pollwinner

classmethod new_priority(v: int) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The priority

classmethod new_prodid(v: str) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The prodid

classmethod new_query(v: str) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The query

classmethod new_queryid(v: str) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The queryid

classmethod new_querylevel(v: PropertyQuerylevel) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The querylevel

classmethod new_queryname(v: str) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The queryname

classmethod new_rdate(v: Datetimeperiod) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The rdate

classmethod new_recuraccepted(v: str) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The recuraccepted

classmethod new_recurexpand(v: str) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The recurexpand

classmethod new_recurlimit(v: str) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The recurlimit

classmethod new_recurrenceid(v: Time) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The time of recurrenceid

classmethod new_relatedto(v: str) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The relatedto

classmethod new_relcalid(v: str) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The relcalid

classmethod new_repeat(v: int) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The repeat

classmethod new_replyurl(v: str) → Property

Creates a new Property.

Added in version 2.0.

Parameters:

v – The replyurl

classmethod new_requeststatus(v: Reqstat) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The requeststatus

classmethod new_resources(v: str) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The resources

classmethod new_response(v: int) → Property

Creates a new Property.

Added in version 2.0.

Parameters:

v – The response

classmethod new_restriction(v: str) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The restriction

classmethod new_rrule(v: Recurrence) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The rrule recurrence type

classmethod new_scope(v: str) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The scope

classmethod new_sequence(v: int) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The sequence

classmethod new_status(v: PropertyStatus) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The status

classmethod new_storesexpanded(v: str) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The storesexpanded

classmethod new_summary(v: str) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The summary

classmethod new_target(v: str) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The target

classmethod new_taskmode(v: PropertyTaskmode) → Property

Creates a new Property.

Added in version 2.0.

Parameters:

v – The taskmode

classmethod new_transp(v: PropertyTransp) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The transp

classmethod new_trigger(v: Trigger) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The trigger period type

classmethod new_tzid(v: str) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The tzid

classmethod new_tzidaliasof(v: str) → Property

Creates a new Property.

Added in version 2.0.

Parameters:

v – The tzidaliasof

classmethod new_tzname(v: str) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The tzname

classmethod new_tzoffsetfrom(v: int) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The tzoffsetfrom

classmethod new_tzoffsetto(v: int) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The tzoffsetto

classmethod new_tzuntil(v: Time) → Property

Creates a new Property.

Added in version 2.0.

Parameters:

v – The time of acknowledgement

classmethod new_tzurl(v: str) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The tzurl

classmethod new_uid(v: str) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The uid

classmethod new_url(v: str) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The url

classmethod new_version(v: str) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The version

classmethod new_voter(v: str) → Property

Creates a new Property.

Added in version 2.0.

Parameters:

v – The voter

classmethod new_x(v: str) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The x

classmethod new_xlicclass(v: PropertyXlicclass) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The xlicclass

classmethod new_xlicclustercount(v: str) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The xlicclustercount

classmethod new_xlicerror(v: str) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The xlicerror

classmethod new_xlicmimecharset(v: str) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The xlicmimecharset

classmethod new_xlicmimecid(v: str) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The xlicmimecid

classmethod new_xlicmimecontenttype(v: str) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The xlicmimecontenttype

classmethod new_xlicmimeencoding(v: str) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The xlicmimeencoding

classmethod new_xlicmimefilename(v: str) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The xlicmimefilename

classmethod new_xlicmimeoptinfo(v: str) → Property

Creates a new Property.

Added in version 1.0.

Parameters:

v – The xlicmimeoptinfo

Methods

class Property

add_parameter(parameter: Parameter) → None

Adds a Parameter into the Property. It behaves like set the copy of the Parameter. Upon completion the native part of Parameter will be set to NULL.

Added in version 1.0.

Parameters:

parameter – The parameter to be added into prop

as_ical_string() → str

Converts a Property to a string representation.

Added in version 1.0.

clone() → Property

Deeply clone a Property.

Added in version 1.0.

count_parameters() → int

Counts the parameters in the Property.

Added in version 1.0.

classmethod enum_to_string() → str

Converts the enum to string.

Added in version 1.0.

get_acceptresponse() → str

Gets the acceptresponse of Property.

Added in version 2.0.

get_acknowledged() → Time

Gets the acknowledged time of Property.

Added in version 1.0.

get_action() → PropertyAction

Gets the action of Property.

Added in version 1.0.

get_allowconflict() → str

Gets the allowconflict of Property.

Added in version 1.0.

get_attach() → Attach

Gets the attach of Property.

Added in version 1.0.

get_attendee() → str

Gets the attendee of Property.

Added in version 1.0.

get_busytype() → PropertyBusytype

Gets the busytype of Property.

Added in version 2.0.

get_calid() → str

Gets the calid of Property.

Added in version 1.0.

get_calmaster() → str

Gets the calmaster of Property.

Added in version 1.0.

get_calscale() → str

Gets the calscale of Property.

Added in version 1.0.

get_capversion() → str

Gets the capversion of Property.

Added in version 1.0.

get_carid() → str

Gets the carid of Property.

Added in version 1.0.

get_carlevel() → PropertyCarlevel

Gets the carlevel of Property.

Added in version 1.0.

get_categories() → str

Gets the categories of Property.

Added in version 1.0.

get_class() → Property_Class

Gets the class of Property.

Added in version 1.0.

get_cmd() → PropertyCmd

Gets the cmd of Property.

Added in version 1.0.

get_color() → str

Gets the color property of the prop.

Added in version 3.0.5.

get_comment() → str

Gets the comment of Property.

Added in version 1.0.

get_completed() → Time

Gets the completed time of Property.

Added in version 1.0.

get_components() → str

Gets the components of Property.

Added in version 1.0.

get_contact() → str

Gets the contact of Property.

Added in version 1.0.

get_created() → Time

Gets the created time of Property.

Added in version 1.0.

get_csid() → str

Gets the csid of Property.

Added in version 1.0.

get_datemax() → Time

Gets the datemax time of Property.

Added in version 1.0.

get_datemin() → Time

Gets the datemin time of Property.

Added in version 1.0.

get_datetime_with_component(comp: Component | None = None) → Time

If the property is a DATE-TIME with a TZID parameter and a corresponding VTIMEZONE is present in the component, the returned component will already be in the correct timezone; otherwise the caller is responsible for converting it.

The comp can be NULL, in which case the parent of the prop is used to find the corresponding time zone.

Added in version 3.0.5.

Parameters:

comp – An Component

get_decreed() → str

Gets the decreed of Property.

Added in version 1.0.

get_defaultcharset() → str

Gets the defaultcharset of Property.

Added in version 1.0.

get_defaultlocale() → str

Gets the defaultlocale of Property.

Added in version 1.0.

get_defaulttzid() → str

Gets the defaulttzid of Property.

Added in version 1.0.

get_defaultvcars() → str

Gets the defaultvcars of Property.

Added in version 1.0.

get_deny() → str

Gets the deny of Property.

Added in version 1.0.

get_description() → str

Gets the description of Property.

Added in version 1.0.

get_dtend() → Time

Gets the dtend time of Property.

Added in version 1.0.

get_dtstamp() → Time

Gets the dtstamp time of Property.

Added in version 1.0.

get_dtstart() → Time

Gets the dtstart time of Property.

Added in version 1.0.

get_due() → Time

Gets the due time of Property.

Added in version 1.0.

get_duration() → Duration

Gets the duration of Property.

Added in version 1.0.

get_estimatedduration() → Duration

Gets the estimatedduration of Property.

Added in version 1.0.

get_exdate() → Time

Gets the exdate time of Property.

Added in version 1.0.

get_expand() → int

Gets the expand of Property.

Added in version 1.0.

get_exrule() → Recurrence

Gets the exrule recurrence type of Property.

Added in version 1.0.

get_first_parameter(kind: ParameterKind) → Parameter

Gets the first Parameter from the parent Property.

Added in version 1.0.

Parameters:

kind – The target kind of Parameter to be retrieved

get_freebusy() → Period

Gets the freebusy period type of Property.

Added in version 1.0.

get_geo() → Geo

Gets the geo type of Property.

Added in version 1.0.

get_grant() → str

Gets the grant of Property.

Added in version 1.0.

get_itipversion() → str

Gets the itipversion of Property.

Added in version 1.0.

get_lastmodified() → Time

Gets the lastmodified time of Property.

Added in version 1.0.

get_location() → str

Gets the location of Property.

Added in version 1.0.

get_maxcomponentsize() → int

Gets the maxcomponentsize of Property.

Added in version 1.0.

get_maxdate() → Time

Gets the maxdate time of Property.

Added in version 1.0.

get_maxresults() → int

Gets the maxresults of Property.

Added in version 1.0.

get_maxresultssize() → int

Gets the maxresultssize of Property.

Added in version 1.0.

get_method() → PropertyMethod

Gets the method of Property.

Added in version 1.0.

get_mindate() → Time

Gets the mindate time of Property.

Added in version 1.0.

get_multipart() → str

Gets the multipart of Property.

Added in version 1.0.

get_name() → str

Gets the name of Property.

Added in version 1.0.

get_next_parameter(kind: ParameterKind) → Parameter

Gets the next Parameter from the parent Property.

Added in version 1.0.

Parameters:

kind – The target kind of Parameter to be retrieved

get_organizer() → str

Gets the organizer of Property.

Added in version 1.0.

get_owner() → str

Gets the owner of Property.

Added in version 1.0.

get_parameter_as_string(name: str) → str

Gets the string representation of the target parameter in the Property.

Added in version 1.0.

Parameters:

name – The name of the target parameter

get_parent() → Component | None

Gets the parent component of the property. Use with caution. When icalproperty is deallocated, it won’t deallocate its parent. However the Component object created using this method will be deallocated (if no reference in other places). So You need to make sure there is another reference except the one in Property.

Added in version 2.0.

get_percentcomplete() → int

Gets the percentcomplete of Property.

Added in version 1.0.

get_permission() → str

Gets the permission of Property.

Added in version 1.0.

get_pollcompletion() → PropertyPollcompletion

Gets the pollcompletion of Property.

Added in version 1.0.

get_pollitemid() → int

Gets the pollitemid of Property.

Added in version 1.0.

get_pollmode() → PropertyPollmode

Gets the pollmode of Property.

Added in version 1.0.

get_pollproperties() → str

Gets the pollproperties of Property.

Added in version 1.0.

get_pollwinner() → int

Gets the pollwinner of Property.

Added in version 1.0.

get_priority() → int

Gets the priority of Property.

Added in version 1.0.

get_prodid() → str

Gets the prodid of Property.

Added in version 1.0.

get_property_name() → str

Gets the property name of Property.

Added in version 1.0.

get_query() → str

Gets the query of Property.

Added in version 1.0.

get_queryid() → str

Gets the queryid of Property.

Added in version 1.0.

get_querylevel() → PropertyQuerylevel

Gets the querylevel of Property.

Added in version 1.0.

get_queryname() → str

Gets the queryname of Property.

Added in version 1.0.

get_rdate() → Datetimeperiod

Gets the rdate of Property.

Added in version 1.0.

get_recuraccepted() → str

Gets the recuraccepted of Property.

Added in version 1.0.

get_recurexpand() → str

Gets the recurexpand of Property.

Added in version 1.0.

get_recurlimit() → str

Gets the recurlimit of Property.

Added in version 1.0.

get_recurrenceid() → Time

Gets the recurrenceid time of Property.

Added in version 1.0.

get_relatedto() → str

Gets the relatedto of Property.

Added in version 1.0.

get_relcalid() → str

Gets the relcalid of Property.

Added in version 1.0.

get_repeat() → int

Gets the repeat of Property.

Added in version 1.0.

get_replyurl() → str

Gets the replyurl of Property.

Added in version 2.0.

get_requeststatus() → Reqstat

Gets the requeststatus of Property.

Added in version 1.0.

get_resources() → str

Gets the resources of Property.

Added in version 1.0.

get_response() → int

Gets the response of Property.

Added in version 2.0.

get_restriction() → str

Gets the restriction of Property.

Added in version 1.0.

get_rrule() → Recurrence

Gets the rrule recurrence type of Property.

Added in version 1.0.

get_scope() → str

Gets the scope of Property.

Added in version 1.0.

get_sequence() → int

Gets the sequence of Property.

Added in version 1.0.

get_status() → PropertyStatus

Gets the status of Property.

Added in version 1.0.

get_storesexpanded() → str

Gets the storesexpanded of Property.

Added in version 1.0.

get_summary() → str

Gets the summary of Property.

Added in version 1.0.

get_target() → str

Gets the target of Property.

Added in version 1.0.

get_taskmode() → PropertyTaskmode

Gets the taskmode of Property.

Added in version 2.0.

get_transp() → PropertyTransp

Gets the transp of Property.

Added in version 1.0.

get_trigger() → Trigger

Gets the trigger period type of Property.

Added in version 1.0.

get_tzid() → str

Gets the tzid of Property.

Added in version 1.0.

get_tzidaliasof() → str

Gets the tzidaliasof of Property.

Added in version 2.0.

get_tzname() → str

Gets the tzname of Property.

Added in version 1.0.

get_tzoffsetfrom() → int

Gets the tzoffsetfrom of Property.

Added in version 1.0.

get_tzoffsetto() → int

Gets the tzoffsetto of Property.

Added in version 1.0.

get_tzuntil() → Time

Gets the tzuntil time of Property.

Added in version 2.0.

get_tzurl() → str

Gets the tzurl of Property.

Added in version 1.0.

get_uid() → str

Gets the uid of Property.

Added in version 1.0.

get_url() → str

Gets the url of Property.

Added in version 1.0.

get_value() → Value

Gets the Value of Property.

Added in version 1.0.

get_value_as_string() → str

Gets the string representation of the value in Property.

Added in version 1.0.

get_version() → str

Gets the version of Property.

Added in version 1.0.

get_voter() → str

Gets the voter of Property.

Added in version 2.0.

get_x() → str

Gets the x of Property.

Added in version 1.0.

get_x_name() → str | None

Gets the name of x property.

Added in version 1.0.

get_xlicclass() → PropertyXlicclass

Gets the xlicclass of Property.

Added in version 1.0.

get_xlicclustercount() → str

Gets the xlicclustercount of Property.

Added in version 1.0.

get_xlicerror() → str

Gets the xlicerror of Property.

Added in version 1.0.

get_xlicmimecharset() → str

Gets the xlicmimecharset of Property.

Added in version 1.0.

get_xlicmimecid() → str

Gets the xlicmimecid of Property.

Added in version 1.0.

get_xlicmimecontenttype() → str

Gets the xlicmimecontenttype of Property.

Added in version 1.0.

get_xlicmimeencoding() → str

Gets the xlicmimeencoding of Property.

Added in version 1.0.

get_xlicmimefilename() → str

Gets the xlicmimefilename of Property.

Added in version 1.0.

get_xlicmimeoptinfo() → str

Gets the xlicmimeoptinfo of Property.

Added in version 1.0.

isa() → PropertyKind

Gets the kind of Property.

Added in version 1.0.

isa_property() → int

Checks whether the native part of Property is of the type icalproperty.

Added in version 1.0.

classmethod kind_and_string_to_enum(str: str) → int

Converts a integer and string into an enum.

Added in version 1.0.

Parameters:

str – A string

classmethod kind_from_string() → PropertyKind

Converts the string to PropertyKind.

Added in version 1.0.

classmethod kind_has_property(e: int) → int

Checks whether the enum belongs to the PropertyKind.

Added in version 1.0.

Parameters:

e – The enum to be checked

classmethod kind_is_valid() → bool

Checks whether PropertyKind is valid.

Added in version 1.0.

classmethod kind_to_string() → str

Converts the PropertyKind to a string.

Added in version 1.0.

classmethod kind_to_value_kind() → ValueKind

Converts the PropertyKind to ValueKind.

Added in version 1.0.

classmethod method_from_string() → PropertyMethod

Converts the string to PropertyKind.

Added in version 1.0.

classmethod method_to_string() → str

Converts the PropertyMethod to string.

Added in version 1.0.

classmethod recurrence_is_excluded(dtstart: Time, recurtime: Time) → bool

Decides if this recurrence is acceptable. This function decides if a specific recurrence value is excluded by EXRULE or EXDATE properties.

Added in version 1.0.

Parameters:

• dtstart – The base dtstart value for this component

• recurtime – The time to test against

remove_parameter_by_kind(kind: ParameterKind) → None

Removes the target kind of the parameters in the Property.

Added in version 1.0.

Parameters:

kind – The ParameterKind to be removed

remove_parameter_by_name(name: str) → None

Removes parameter in the Property by name.

Added in version 1.0.

Parameters:

name – The name of the parameter to be removed

set_acceptresponse(v: str) → None

Sets the acceptresponse for the Property.

Added in version 2.0.

Parameters:

v – The acceptresponse

set_acknowledged(v: Time) → None

Sets the acknowledged time for the Property.

Added in version 1.0.

Parameters:

v – The acknowledgement time

set_action(v: PropertyAction) → None

Sets the action for the Property.

Added in version 1.0.

Parameters:

v – The action

set_allowconflict(v: str) → None

Sets the allowconflict for the Property.

Added in version 1.0.

Parameters:

v – The allowconflict

set_attach(v: Attach) → None

Sets the attach for the Property.

Added in version 1.0.

Parameters:

v – The attach

set_attendee(v: str) → None

Sets the attendee for the Property.

Added in version 1.0.

Parameters:

v – The attendee

set_busytype(v: PropertyBusytype) → None

Sets the busytype for the Property.

Added in version 2.0.

Parameters:

v – The busytype

set_calid(v: str) → None

Sets the calid for the Property.

Added in version 1.0.

Parameters:

v – The calid

set_calmaster(v: str) → None

Sets the calmaster for the Property.

Added in version 1.0.

Parameters:

v – The calmaster

set_calscale(v: str) → None

Sets the calscale for the Property.

Added in version 1.0.

Parameters:

v – The calscale

set_capversion(v: str) → None

Sets the capversion for the Property.

Added in version 1.0.

Parameters:

v – The capversion

set_carid(v: str) → None

Sets the carid for the Property.

Added in version 1.0.

Parameters:

v – The carid

set_carlevel(v: PropertyCarlevel) → None

Sets the carlevel for the Property.

Added in version 1.0.

Parameters:

v – The carlevel

set_categories(v: str) → None

Sets the categories for the Property.

Added in version 1.0.

Parameters:

v – The categories

set_class(v: Property_Class) → None

Sets the class for the Property.

Added in version 1.0.

Parameters:

v – The class

set_cmd(v: PropertyCmd) → None

Sets the cmd for the Property.

Added in version 1.0.

Parameters:

v – The cmd

set_color(v: str) → None

Sets the color for the prop.

Added in version 1.0.

Parameters:

v – The color

set_comment(v: str) → None

Sets the comment for the Property.

Added in version 1.0.

Parameters:

v – The comment

set_completed(v: Time) → None

Sets the completed time for the Property.

Added in version 1.0.

Parameters:

v – The completed time

set_components(v: str) → None

Sets the components for the Property.

Added in version 1.0.

Parameters:

v – The components

set_contact(v: str) → None

Sets the contact for the Property.

Added in version 1.0.

Parameters:

v – The contact

set_created(v: Time) → None

Sets the created time for the Property.

Added in version 1.0.

Parameters:

v – The created time

set_csid(v: str) → None

Sets the csid for the Property.

Added in version 1.0.

Parameters:

v – The csid

set_datemax(v: Time) → None

Sets the datemax time for the Property.

Added in version 1.0.

Parameters:

v – The datemax time

set_datemin(v: Time) → None

Sets the datemin time for the Property.

Added in version 1.0.

Parameters:

v – The datemin time

set_decreed(v: str) → None

Sets the decreed for the Property.

Added in version 1.0.

Parameters:

v – The decreed

set_defaultcharset(v: str) → None

Sets the defaultcharset for the Property.

Added in version 1.0.

Parameters:

v – The defaultcharset

set_defaultlocale(v: str) → None

Sets the defaultlocale for the Property.

Added in version 1.0.

Parameters:

v – The defaultlocale

set_defaulttzid(v: str) → None

Sets the defaulttzid for the Property.

Added in version 1.0.

Parameters:

v – The defaulttzid

set_defaultvcars(v: str) → None

Sets the defaultvcars for the Property.

Added in version 1.0.

Parameters:

v – The defaultvcars

set_deny(v: str) → None

Sets the deny for the Property.

Added in version 1.0.

Parameters:

v – The deny

set_description(v: str) → None

Sets the description for the Property.

Added in version 1.0.

Parameters:

v – The description

set_dtend(v: Time) → None

Sets the dtend time for the Property.

Added in version 1.0.

Parameters:

v – The dtend time

set_dtstamp(v: Time) → None

Sets the dtstamp time for the Property.

Added in version 1.0.

Parameters:

v – The dtstamp time

set_dtstart(v: Time) → None

Sets the dtstart time for the Property.

Added in version 1.0.

Parameters:

v – The dtstart time

set_due(v: Time) → None

Sets the due time for the Property.

Added in version 1.0.

Parameters:

v – The due time

set_duration(v: Duration) → None

Sets the duration for the Property.

Added in version 1.0.

Parameters:

v – The duration

set_estimatedduration(v: Duration) → None

Sets the estimatedduration for the Property.

Added in version 1.0.

Parameters:

v – The estimatedduration

set_exdate(v: Time) → None

Sets the exdate time for the Property.

Added in version 1.0.

Parameters:

v – The exdate time

set_expand(v: int) → None

Sets the expand for the Property.

Added in version 1.0.

Parameters:

v – The expand

set_exrule(v: Recurrence) → None

Sets the exrule time for the Property.

Added in version 1.0.

Parameters:

v – The exrule recurrence type

set_freebusy(v: Period) → None

Sets the freebusy time for the Property.

Added in version 1.0.

Parameters:

v – The freebusy period type

set_geo(v: Geo) → None

Sets the geo for the Property.

Added in version 1.0.

Parameters:

v – The geo type

set_grant(v: str) → None

Sets the grant for the Property.

Added in version 1.0.

Parameters:

v – The grant

set_itipversion(v: str) → None

Sets the itipversion for the Property.

Added in version 1.0.

Parameters:

v – The itipversion

set_lastmodified(v: Time) → None

Sets the lastmodified time for the Property.

Added in version 1.0.

Parameters:

v – The lastmodified time

set_location(v: str) → None

Sets the location for the Property.

Added in version 1.0.

Parameters:

v – The location

set_maxcomponentsize(v: int) → None

Sets the maxcomponentsize for the Property.

Added in version 1.0.

Parameters:

v – The maxcomponentsize

set_maxdate(v: Time) → None

Sets the maxdate time for the Property.

Added in version 1.0.

Parameters:

v – The maxdate time

set_maxresults(v: int) → None

Sets the maxresults for the Property.

Added in version 1.0.

Parameters:

v – The maxresults

set_maxresultssize(v: int) → None

Sets the maxresultssize for the Property.

Added in version 1.0.

Parameters:

v – The maxresultssize

set_method(v: PropertyMethod) → None

Sets the method for the Property.

Added in version 1.0.

Parameters:

v – The method

set_mindate(v: Time) → None

Sets the mindate time for the Property.

Added in version 1.0.

Parameters:

v – The mindate time

set_multipart(v: str) → None

Sets the multipart for the Property.

Added in version 1.0.

Parameters:

v – The multipart

set_name(v: str) → None

Sets the name for the Property.

Added in version 1.0.

Parameters:

v – The name

set_organizer(v: str) → None

Sets the organizer for the Property.

Added in version 1.0.

Parameters:

v – The organizer

set_owner(v: str) → None

Sets the owner for the Property.

Added in version 1.0.

Parameters:

v – The owner

set_parameter(parameter: Parameter) → None

Sets a Parameter into the Property. It behaves like set the copy of the Parameter. Upon completion the native part of Parameter will be set to NULL.

Added in version 1.0.

Parameters:

parameter – The parameter to be set into prop

set_parameter_from_string(name: str, value: str) → None

Sets the Property with the parameter defined by the name and value.

Added in version 1.0.

Parameters:

• name – The name of the parameter

• value – The value of the parameter

set_parent(component: Component | None = None) → None

Sets the parent Component of the specified Property.

Added in version 3.0.

Parameters:

component – An Component

set_percentcomplete(v: int) → None

Sets the percentcomplete for the Property.

Added in version 1.0.

Parameters:

v – The percentcomplete

set_permission(v: str) → None

Sets the permission for the Property.

Added in version 1.0.

Parameters:

v – The permission

set_pollcompletion(v: PropertyPollcompletion) → None

Sets the pollcompletion for the Property.

Added in version 1.0.

Parameters:

v – The pollcompletion

set_pollitemid(v: int) → None

Sets the pollitemid for the Property.

Added in version 1.0.

Parameters:

v – The pollitemid

set_pollmode(v: PropertyPollmode) → None

Sets the pollmode for the Property.

Added in version 1.0.

Parameters:

v – The pollmode

set_pollproperties(v: str) → None

Sets the pollproperties for the Property.

Added in version 1.0.

Parameters:

v – The pollproperties

set_pollwinner(v: int) → None

Sets the pollwinner for the Property.

Added in version 1.0.

Parameters:

v – The pollwinner

set_priority(v: int) → None

Sets the priority for the Property.

Added in version 1.0.

Parameters:

v – The priority

set_prodid(v: str) → None

Sets the prodid for the Property.

Added in version 1.0.

Parameters:

v – The prodid

set_query(v: str) → None

Sets the query for the Property.

Added in version 1.0.

Parameters:

v – The query

set_queryid(v: str) → None

Sets the queryid for the Property.

Added in version 1.0.

Parameters:

v – The queryid

set_querylevel(v: PropertyQuerylevel) → None

Sets the querylevel for the Property.

Added in version 1.0.

Parameters:

v – The querylevel

set_queryname(v: str) → None

Sets the queryname for the Property.

Added in version 1.0.

Parameters:

v – The queryname

set_rdate(v: Datetimeperiod) → None

Sets the rdate for the Property.

Added in version 1.0.

Parameters:

v – The rdate

set_recuraccepted(v: str) → None

Sets the recuraccepted for the Property.

Added in version 1.0.

Parameters:

v – The recuraccepted

set_recurexpand(v: str) → None

Sets the recurexpand for the Property.

Added in version 1.0.

Parameters:

v – The recurexpand

set_recurlimit(v: str) → None

Sets the recurlimit for the Property.

Added in version 1.0.

Parameters:

v – The recurlimit

set_recurrenceid(v: Time) → None

Sets the recurrenceid time for the Property.

Added in version 1.0.

Parameters:

v – The recurrenceid time

set_relatedto(v: str) → None

Sets the relatedto for the Property.

Added in version 1.0.

Parameters:

v – The relatedto

set_relcalid(v: str) → None

Sets the relcalid for the Property.

Added in version 1.0.

Parameters:

v – The relcalid

set_repeat(v: int) → None

Sets the repeat for the Property.

Added in version 1.0.

Parameters:

v – The repeat

set_replyurl(v: str) → None

Sets the replyurl for the Property.

Added in version 2.0.

Parameters:

v – The replyurl

set_requeststatus(v: Reqstat) → None

Sets the requeststatus for the Property.

Added in version 1.0.

Parameters:

v – The requeststatus

set_resources(v: str) → None

Sets the resources for the Property.

Added in version 1.0.

Parameters:

v – The resources

set_response(v: int) → None

Sets the response for the Property.

Added in version 2.0.

Parameters:

v – The response

set_restriction(v: str) → None

Sets the restriction for the Property.

Added in version 1.0.

Parameters:

v – The restriction

set_rrule(v: Recurrence) → None

Sets the rrule for the Property.

Added in version 1.0.

Parameters:

v – The rrule recurrence type

set_scope(v: str) → None

Sets the scope for the Property.

Added in version 1.0.

Parameters:

v – The scope

set_sequence(v: int) → None

Sets the sequence for the Property.

Added in version 1.0.

Parameters:

v – The sequence

set_status(v: PropertyStatus) → None

Sets the status for the Property.

Added in version 1.0.

Parameters:

v – The status

set_storesexpanded(v: str) → None

Sets the storesexpanded for the Property.

Added in version 1.0.

Parameters:

v – The storesexpanded

set_summary(v: str) → None

Sets the summary for the Property.

Added in version 1.0.

Parameters:

v – The summary

set_target(v: str) → None

Sets the target for the Property.

Added in version 1.0.

Parameters:

v – The target

set_taskmode(v: PropertyTaskmode) → None

Sets the taskmode for the Property.

Added in version 2.0.

Parameters:

v – The taskmode

set_transp(v: PropertyTransp) → None

Sets the transp for the Property.

Added in version 1.0.

Parameters:

v – The transp

set_trigger(v: Trigger) → None

Sets the trigger time for the Property.

Added in version 1.0.

Parameters:

v – The trigger period type

set_tzid(v: str) → None

Sets the tzid for the Property.

Added in version 1.0.

Parameters:

v – The tzid

set_tzidaliasof(v: str) → None

Sets the tzidaliasof for the Property.

Added in version 2.0.

Parameters:

v – The tzidaliasof

set_tzname(v: str) → None

Sets the tzname for the Property.

Added in version 1.0.

Parameters:

v – The tzname

set_tzoffsetfrom(v: int) → None

Sets the tzoffsetfrom for the Property.

Added in version 1.0.

Parameters:

v – The tzoffsetfrom

set_tzoffsetto(v: int) → None

Sets the tzoffsetto for the Property.

Added in version 1.0.

Parameters:

v – The tzoffsetto

set_tzuntil(v: Time) → None

Sets the tzuntil time for the Property.

Added in version 2.0.

Parameters:

v – The acknowledgement time

set_tzurl(v: str) → None

Sets the tzurl for the Property.

Added in version 1.0.

Parameters:

v – The tzurl

set_uid(v: str) → None

Sets the uid for the Property.

Added in version 1.0.

Parameters:

v – The uid

set_url(v: str) → None

Sets the url for the Property.

Added in version 1.0.

Parameters:

v – The url

set_value(value: Value) → None

Sets the Property with the Value.

Added in version 1.0.

Parameters:

value – The Value will be set as the property of prop

set_value_from_string(value: str, kind: str) → None

Sets the Property with the Value constructed from string.

Added in version 1.0.

Parameters:

• value – The value used to construct the Value

• kind – The kind used to construct the Value

set_version(v: str) → None

Sets the version for the Property.

Added in version 1.0.

Parameters:

v – The version

set_voter(v: str) → None

Sets the voter for the Property.

Added in version 2.0.

Parameters:

v – The voter

set_x(v: str) → None

Sets the x for the Property.

Added in version 1.0.

Parameters:

v – The x

set_x_name(name: str) → None

Sets the name of x property for the Property.

Added in version 1.0.

Parameters:

name – The name string

set_xlicclass(v: PropertyXlicclass) → None

Sets the xlicclass for the Property.

Added in version 1.0.

Parameters:

v – The xlicclass

set_xlicclustercount(v: str) → None

Sets the xlicclustercount for the Property.

Added in version 1.0.

Parameters:

v – The xlicclustercount

set_xlicerror(v: str) → None

Sets the xlicerror for the Property.

Added in version 1.0.

Parameters:

v – The xlicerror

set_xlicmimecharset(v: str) → None

Sets the xlicmimecharset for the Property.

Added in version 1.0.

Parameters:

v – The xlicmimecharset

set_xlicmimecid(v: str) → None

Sets the xlicmimecid for the Property.

Added in version 1.0.

Parameters:

v – The xlicmimecid

set_xlicmimecontenttype(v: str) → None

Sets the xlicmimecontenttype for the Property.

Added in version 1.0.

Parameters:

v – The xlicmimecontenttype

set_xlicmimeencoding(v: str) → None

Sets the xlicmimeencoding for the Property.

Added in version 1.0.

Parameters:

v – The xlicmimeencoding

set_xlicmimefilename(v: str) → None

Sets the xlicmimefilename for the Property.

Added in version 1.0.

Parameters:

v – The xlicmimefilename

set_xlicmimeoptinfo(v: str) → None

Sets the xlicmimeoptinfo for the Property.

Added in version 1.0.

Parameters:

v – The xlicmimeoptinfo

classmethod status_from_string() → PropertyStatus

Converts the string to PropertyKind.

Added in version 1.0.

classmethod status_to_string() → str

Converts the PropertyStatus to string.

Added in version 1.0.