Parameter

class Parameter(**properties: Any)

Superclasses: Object, Object

This is the ICalParameter instance.

Constructors

class Parameter

classmethod new(v: ParameterKind) → Parameter

Creates a new Parameter according to the kind type.

Added in version 1.0.

Parameters:

v – The type of Parameter to be created

classmethod new_actionparam(v: ParameterAction) → Parameter

Creates a new Parameter according to the action type.

Added in version 1.0.

Parameters:

v – The type of Parameter to be created

classmethod new_altrep(v: str) → Parameter

Added in version 1.0.

Parameters:

v – The string used to create the new Parameter

classmethod new_charset(v: str) → Parameter

Added in version 1.0.

Parameters:

v – The string used to create the new Parameter

classmethod new_cn(v: str) → Parameter

Added in version 1.0.

Parameters:

v – The string used to create the new Parameter

classmethod new_cutype(v: ParameterCutype) → Parameter

Added in version 1.0.

Parameters:

v – The type of Parameter to be created

classmethod new_delegatedfrom(v: str) → Parameter

Added in version 1.0.

Parameters:

v – The string used to create the new Parameter

classmethod new_delegatedto(v: str) → Parameter

Added in version 1.0.

Parameters:

v – The string used to create the new Parameter

classmethod new_dir(v: str) → Parameter

Added in version 1.0.

Parameters:

v – The string used to create the new Parameter

classmethod new_display(value: ParameterDisplay) → Parameter

Added in version 3.0.15.

Parameters:

value – The ParameterDisplay value of the new Parameter

classmethod new_email(value: str) → Parameter

Added in version 3.0.15.

Parameters:

value – The string value of the new Parameter

classmethod new_enable(v: ParameterEnable) → Parameter

Creates a new Parameter according to the enable type.

Added in version 1.0.

Parameters:

v – The type of Parameter to be created

classmethod new_encoding(v: ParameterEncoding) → Parameter

Creates a new Parameter according to the encoding type.

Added in version 1.0.

Parameters:

v – The type of Parameter to be created

classmethod new_fbtype(v: ParameterFbtype) → Parameter

Creates a new Parameter according to the fbtype type.

Added in version 1.0.

Parameters:

v – The type of Parameter to be created

classmethod new_feature(value: ParameterFeature) → Parameter

Added in version 3.0.15.

Parameters:

value – The ParameterFeature value of the new Parameter

classmethod new_filename(v: str) → Parameter

Added in version 2.0.

Parameters:

v – The string used to create the new Parameter

classmethod new_fmttype(v: str) → Parameter

Added in version 1.0.

Parameters:

v – The string used to create the new Parameter

classmethod new_from_string(value: str) → Parameter

Creates a Parameter from a string of form “PARAMNAME=VALUE”.

Added in version 1.0.

Parameters:

value – The string from which the Parameter is created

classmethod new_from_value_string(kind: ParameterKind, value: str) → Parameter

Creates a new Parameter from just the value, the part after the “=”

Added in version 1.0.

Parameters:

• kind – The kind of Parameter to be created

• value – The string from which Parameter to be created

classmethod new_iana(v: str) → Parameter

Added in version 1.0.

Parameters:

v – The string used to create the new Parameter

classmethod new_id(v: str) → Parameter

Added in version 1.0.

Parameters:

v – The string used to create the new Parameter

classmethod new_label(value: str) → Parameter

Added in version 3.0.15.

Parameters:

value – The string value of the new Parameter

classmethod new_language(v: str) → Parameter

Added in version 1.0.

Parameters:

v – The string used to create the new Parameter

classmethod new_latency(v: str) → Parameter

Added in version 1.0.

Parameters:

v – The string used to create the new Parameter

classmethod new_local(v: ParameterLocal) → Parameter

Creates a new Parameter according to the local type.

Added in version 1.0.

Parameters:

v – The type of Parameter to be created

classmethod new_localize(v: str) → Parameter

Added in version 1.0.

Parameters:

v – The string used to create the new Parameter

classmethod new_managedid(v: str) → Parameter

Added in version 2.0.

Parameters:

v – The string used to create the new Parameter

classmethod new_member(v: str) → Parameter

Added in version 1.0.

Parameters:

v – The string used to create the new Parameter

classmethod new_modified(v: str) → Parameter

Added in version 2.0.

Parameters:

v – The string used to create the new Parameter

classmethod new_options(v: str) → Parameter

Added in version 1.0.

Parameters:

v – The string used to create the new Parameter

classmethod new_partstat(v: ParameterPartstat) → Parameter

Creates a new Parameter according to the partstat type.

Added in version 1.0.

Parameters:

v – The type of Parameter to be created

classmethod new_patchaction(value: ParameterPatchaction) → Parameter

Added in version 3.0.15.

Parameters:

value – The ParameterPatchaction value of the new Parameter

classmethod new_publiccomment(v: str) → Parameter

Added in version 2.0.

Parameters:

v – The string used to create the new Parameter

classmethod new_range(v: ParameterRange) → Parameter

Creates a new Parameter according to the range type.

Added in version 1.0.

Parameters:

v – The type of Parameter to be created

classmethod new_reason(v: str) → Parameter

Added in version 2.0.

Parameters:

v – The string used to create the new Parameter

classmethod new_related(v: ParameterRelated) → Parameter

Creates a new Parameter according to the related type.

Added in version 1.0.

Parameters:

v – The type of Parameter to be created

classmethod new_reltype(v: ParameterReltype) → Parameter

Creates a new Parameter according to the reltype type.

Added in version 1.0.

Parameters:

v – The type of Parameter to be created

classmethod new_required(v: ParameterRequired) → Parameter

Creates a new Parameter according to the required type.

Added in version 2.0.

Parameters:

v – The type of Parameter to be created

classmethod new_response(v: int) → Parameter

Creates a new Parameter according to the response type.

Added in version 2.0.

Parameters:

v – The type of Parameter to be created

classmethod new_role(v: ParameterRole) → Parameter

Creates a new Parameter according to the role type.

Added in version 1.0.

Parameters:

v – The type of Parameter to be created

classmethod new_rsvp(v: ParameterRsvp) → Parameter

Creates a new Parameter according to the rsvp type.

Added in version 1.0.

Parameters:

v – The type of Parameter to be created

classmethod new_scheduleagent(v: ParameterScheduleagent) → Parameter

Creates a new Parameter according to the scheduleagent type.

Added in version 1.0.

Parameters:

v – The type of Parameter to be created

classmethod new_scheduleforcesend(v: ParameterScheduleforcesend) → Parameter

Creates a new Parameter according to the scheduleforcesend type.

Added in version 1.0.

Parameters:

v – The type of Parameter to be created

classmethod new_schedulestatus(v: str) → Parameter

Added in version 1.0.

Parameters:

v – The string used to create the new Parameter

classmethod new_sentby(v: str) → Parameter

Added in version 1.0.

Parameters:

v – The string used to create the new Parameter

classmethod new_size(v: str) → Parameter

Added in version 2.0.

Parameters:

v – The string used to create the new Parameter

classmethod new_stayinformed(v: ParameterStayinformed) → Parameter

Creates a new Parameter according to the stayinformed type.

Added in version 2.0.

Parameters:

v – The type of Parameter to be created

classmethod new_substate(v: ParameterSubstate) → Parameter

Creates a new Parameter according to the substate type.

Added in version 1.0.

Parameters:

v – The type of Parameter to be created

classmethod new_tzid(v: str) → Parameter

Added in version 1.0.

Parameters:

v – The string used to create the new Parameter

classmethod new_value(v: ParameterValue) → Parameter

Creates a new Parameter according to the value type.

Added in version 1.0.

Parameters:

v – The type of Parameter to be created

classmethod new_x(v: str) → Parameter

Added in version 1.0.

Parameters:

v – The string used to create the new Parameter

classmethod new_xliccomparetype(v: ParameterXliccomparetype) → Parameter

Creates a new Parameter according to the xliccomparetype type.

Added in version 1.0.

Parameters:

v – The type of Parameter to be created

classmethod new_xlicerrortype(v: ParameterXlicerrortype) → Parameter

Creates a new Parameter according to the xlicerrortype type.

Added in version 1.0.

Parameters:

v – The type of Parameter to be created

Methods

class Parameter

as_ical_string() → str

Converts an Parameter to the string representation.

Added in version 1.0.

clone() → Parameter

Deep clone a Parameter.

Added in version 1.0.

get_actionparam() → ParameterAction

Added in version 1.0.

get_altrep() → str | None

Added in version 1.0.

get_charset() → str | None

Added in version 1.0.

get_cn() → str | None

Added in version 1.0.

get_cutype() → ParameterCutype | None

Added in version 1.0.

get_delegatedfrom() → str | None

Added in version 1.0.

get_delegatedto() → str | None

Added in version 1.0.

get_dir() → str | None

Added in version 1.0.

get_display() → ParameterDisplay

Added in version 3.0.15.

get_email() → str | None

Added in version 3.0.15.

get_enable() → ParameterEnable

Added in version 1.0.

get_encoding() → ParameterEncoding

Added in version 1.0.

get_fbtype() → ParameterFbtype

Added in version 1.0.

get_feature() → ParameterFeature

Added in version 3.0.15.

get_filename() → str | None

Added in version 2.0.

get_fmttype() → str | None

Added in version 1.0.

get_iana() → str | None

Added in version 1.0.

get_iana_name() → str | None

Gets the iana_name property of the native part of the Parameter.

Added in version 1.0.

get_iana_value() → str | None

Gets the iana_value property of the native part of the Parameter.

Added in version 1.0.

get_id() → str | None

Added in version 1.0.

get_label() → str | None

Added in version 3.0.15.

get_language() → str | None

Added in version 1.0.

get_latency() → str | None

Added in version 1.0.

get_local() → ParameterLocal

Added in version 1.0.

get_localize() → str | None

Added in version 1.0.

get_managedid() → str | None

Added in version 2.0.

get_member() → str | None

Added in version 1.0.

get_modified() → str | None

Added in version 2.0.

get_options() → str | None

Added in version 1.0.

get_parent() → Property | None

Gets the parent Property of the specified Parameter.

Added in version 3.0.

get_partstat() → ParameterPartstat

Added in version 1.0.

get_patchaction() → ParameterPatchaction

Added in version 3.0.15.

get_publiccomment() → str | None

Added in version 2.0.

get_range() → ParameterRange

Added in version 1.0.

get_reason() → str | None

Added in version 2.0.

get_related() → ParameterRelated

Added in version 1.0.

get_reltype() → ParameterReltype

Added in version 1.0.

get_required() → ParameterRequired

Added in version 2.0.

get_response() → int

Added in version 2.0.

get_role() → ParameterRole

Added in version 1.0.

get_rsvp() → ParameterRsvp

Added in version 1.0.

get_scheduleagent() → ParameterScheduleagent

Added in version 1.0.

get_scheduleforcesend() → ParameterScheduleforcesend

Added in version 1.0.

get_schedulestatus() → str | None

Added in version 1.0.

get_sentby() → str | None

Added in version 1.0.

get_size() → str | None

Added in version 2.0.

get_stayinformed() → ParameterStayinformed

Added in version 2.0.

get_substate() → ParameterSubstate

Added in version 1.0.

get_tzid() → str | None

Added in version 1.0.

get_value() → ParameterValue

Added in version 1.0.

get_x() → str | None

Added in version 1.0.

get_xliccomparetype() → ParameterXliccomparetype

Added in version 1.0.

get_xlicerrortype() → ParameterXlicerrortype

Added in version 1.0.

get_xname() → str | None

Gets the xname property of the native part of the Parameter.

Added in version 1.0.

get_xvalue() → str | None

Gets the xvalue property of the native part of the Parameter.

Added in version 1.0.

has_same_name(param2: Parameter) → int

Checks whether native parts of two Parameter have the same name.

Added in version 1.0.

Parameters:

param2 – The Parameter to be checked

isa() → ParameterKind

Checks the type of a Parameter.

Added in version 1.0.

isa_parameter() → int

Checks whether the native part of the Parameter is of type icalparameter.

Added in version 1.0.

classmethod kind_from_string() → ParameterKind

Converts a string to the ParameterKind.

Added in version 1.0.

classmethod kind_is_valid() → bool

Checks whether ParameterKind is valid.

Added in version 3.0.5.

classmethod kind_to_string() → str

Converts the Parameter to the string representation.

Added in version 1.0.

set_actionparam(v: ParameterAction) → None

Added in version 1.0.

Parameters:

v – The type of Parameter to be set in the value

set_altrep(v: str) → None

Added in version 1.0.

Parameters:

v – The string used to set into the value

set_charset(v: str) → None

Added in version 1.0.

Parameters:

v – The string used to set into the value

set_cn(v: str) → None

Added in version 1.0.

Parameters:

v – The string used to set into the value

set_cutype(v: ParameterCutype) → None

Added in version 1.0.

Parameters:

v – The ICalParameterCutype used to set value

set_delegatedfrom(v: str) → None

Added in version 1.0.

Parameters:

v – The string used to set into the value

set_delegatedto(v: str) → None

Added in version 1.0.

Parameters:

v – The string used to set into the value

set_dir(v: str) → None

Added in version 1.0.

Parameters:

v – The string used to set into the value

set_display(value: ParameterDisplay) → None

Added in version 3.0.15.

Parameters:

value – The ParameterDisplay to set into the param

set_email(value: str) → None

Added in version 3.0.15.

Parameters:

value – The string value to set into the param

set_enable(v: ParameterEnable) → None

Added in version 1.0.

Parameters:

v – The type of Parameter to be set in the value

set_encoding(v: ParameterEncoding) → None

Added in version 1.0.

Parameters:

v – The type of Parameter to be set in the value

set_fbtype(v: ParameterFbtype) → None

Added in version 1.0.

Parameters:

v – The type of Parameter to be set in the value

set_feature(value: ParameterFeature) → None

Added in version 3.0.15.

Parameters:

value – The ParameterFeature to set into the param

set_filename(v: str) → None

Added in version 2.0.

Parameters:

v – The string used to set into the value

set_fmttype(v: str) → None

Added in version 1.0.

Parameters:

v – The string used to set into the value

set_iana(v: str) → None

Added in version 1.0.

Parameters:

v – The string used to set into the value

set_iana_name(v: str) → None

Sets the iana_name property of the native part of the Parameter.

Added in version 1.0.

Parameters:

v – The name to be set into the param

set_iana_value(v: str) → None

Sets the iana_value property of the native part of the Parameter.

Added in version 1.0.

Parameters:

v – The value to be set into the param

set_id(v: str) → None

Added in version 1.0.

Parameters:

v – The string used to set into the value

set_label(value: str) → None

Added in version 3.0.15.

Parameters:

value – The string value to set into the param

set_language(v: str) → None

Added in version 1.0.

Parameters:

v – The string used to set into the value

set_latency(v: str) → None

Added in version 1.0.

Parameters:

v – The string used to set into the value

set_local(v: ParameterLocal) → None

Added in version 1.0.

Parameters:

v – The type of Parameter to be set in the value

set_localize(v: str) → None

Added in version 1.0.

Parameters:

v – The string used to set into the value

set_managedid(v: str) → None

Added in version 2.0.

Parameters:

v – The string used to set into the value

set_member(v: str) → None

Added in version 1.0.

Parameters:

v – The string used to set into the value

set_modified(v: str) → None

Added in version 2.0.

Parameters:

v – The string used to set into the value

set_options(v: str) → None

Added in version 1.0.

Parameters:

v – The string used to set into the value

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

Sets the parent Property of an Parameter.

Added in version 3.0.

Parameters:

property – The parent Property

set_partstat(v: ParameterPartstat) → None

Added in version 1.0.

Parameters:

v – The type of Parameter to be set in the value

set_patchaction(value: ParameterPatchaction) → None

Added in version 3.0.15.

Parameters:

value – The ParameterPatchaction to set into the param

set_publiccomment(v: str) → None

Added in version 2.0.

Parameters:

v – The string used to set into the value

set_range(v: ParameterRange) → None

Added in version 1.0.

Parameters:

v – The type of Parameter to be set in the value

set_reason(v: str) → None

Added in version 2.0.

Parameters:

v – The string used to set into the value

set_related(v: ParameterRelated) → None

Added in version 1.0.

Parameters:

v – The type of Parameter to be set in the value

set_reltype(v: ParameterReltype) → None

Added in version 1.0.

Parameters:

v – The type of Parameter to be set in the value

set_required(v: ParameterRequired) → None

Added in version 2.0.

Parameters:

v – The type of Parameter to be set in the value

set_response(v: int) → None

Added in version 2.0.

Parameters:

v – The type of Parameter to be set in the value

set_role(v: ParameterRole) → None

Added in version 1.0.

Parameters:

v – The type of Parameter to be set in the value

set_rsvp(v: ParameterRsvp) → None

Added in version 1.0.

Parameters:

v – The type of Parameter to be set in the value

set_scheduleagent(v: ParameterScheduleagent) → None

Added in version 1.0.

Parameters:

v – The type of Parameter to be set in the value

set_scheduleforcesend(v: ParameterScheduleforcesend) → None

Added in version 1.0.

Parameters:

v – The type of Parameter to be set in the value

set_schedulestatus(v: str) → None

Added in version 1.0.

Parameters:

v – The string used to set into the value

set_sentby(v: str) → None

Added in version 1.0.

Parameters:

v – The string used to set into the value

set_size(v: str) → None

Added in version 2.0.

Parameters:

v – The string used to set into the value

set_stayinformed(v: ParameterStayinformed) → None

Added in version 2.0.

Parameters:

v – The type of Parameter to be set in the value

set_substate(v: ParameterSubstate) → None

Added in version 1.0.

Parameters:

v – The type of Parameter to be set in the value

set_tzid(v: str) → None

Added in version 1.0.

Parameters:

v – The string used to set into the value

set_value(v: ParameterValue) → None

Added in version 1.0.

Parameters:

v – The type of Parameter to be set in the value

set_x(v: str) → None

Added in version 1.0.

Parameters:

v – The string used to set into the value

set_xliccomparetype(v: ParameterXliccomparetype) → None

Added in version 1.0.

Parameters:

v – The type of Parameter to be set in the value

set_xlicerrortype(v: ParameterXlicerrortype) → None

Added in version 1.0.

Parameters:

v – The type of Parameter to be set in the value

set_xname(v: str) → None

Sets the xname property of the native part of the Parameter.

Added in version 1.0.

Parameters:

v – The name to be set into the param

set_xvalue(v: str) → None

Sets the xvalue property of the native part of the Parameter.

Added in version 1.0.

Parameters:

v – The value to be set into the param

classmethod value_to_value_kind() → ValueKind

Converts the ParameterValue to ValueKind.

Added in version 1.0.