ICalGLib.Parameter¶
- Subclasses:
None
Methods¶
- Inherited:
- Structs:
Virtual Methods¶
- Inherited:
Properties¶
- Inherited:
Signals¶
- Inherited:
Fields¶
- Inherited:
Class Details¶
- class ICalGLib.Parameter(**kwargs)¶
- Bases:
- Abstract:
No
- Structure:
This is the
ICalGLib.Parameter
instance.- classmethod kind_from_string(string)¶
- Parameters:
string (
str
) – The string representation of theICalGLib.Parameter
- Returns:
The
ICalGLib.ParameterKind
converted from string- Return type:
Converts a string to the
ICalGLib.ParameterKind
.New in version 1.0.
- classmethod kind_is_valid(kind)¶
- Parameters:
kind (
ICalGLib.ParameterKind
) – TheICalGLib.PropertyKind
- Returns:
1 if valid, 0 if not.
- Return type:
Checks whether
ICalGLib.ParameterKind
is valid.New in version 3.0.5.
- classmethod kind_to_string(kind)¶
- Parameters:
kind (
ICalGLib.ParameterKind
) – TheICalGLib.ParameterKind
to be converted- Returns:
The string representation of kind.
- Return type:
Converts the
ICalGLib.Parameter
to the string representation.New in version 1.0.
- classmethod new(v)¶
- Parameters:
v (
ICalGLib.ParameterKind
) – The type ofICalGLib.Parameter
to be created- Returns:
The newly created
ICalGLib.Parameter
.- Return type:
Creates a new
ICalGLib.Parameter
according to the kind type.New in version 1.0.
- classmethod new_actionparam(v)¶
- Parameters:
v (
ICalGLib.ParameterAction
) – The type ofICalGLib.Parameter
to be created- Returns:
The newly created
ICalGLib.Parameter
.- Return type:
Creates a new
ICalGLib.Parameter
according to the action type.New in version 1.0.
- classmethod new_altrep(v)¶
- Parameters:
v (
str
) – The string used to create the newICalGLib.Parameter
- Returns:
The newly created
ICalGLib.Parameter
.- Return type:
New in version 1.0.
- classmethod new_charset(v)¶
- Parameters:
v (
str
) – The string used to create the newICalGLib.Parameter
- Returns:
The newly created
ICalGLib.Parameter
.- Return type:
New in version 1.0.
- classmethod new_cn(v)¶
- Parameters:
v (
str
) – The string used to create the newICalGLib.Parameter
- Returns:
The newly created
ICalGLib.Parameter
.- Return type:
New in version 1.0.
- classmethod new_cutype(v)¶
- Parameters:
v (
ICalGLib.ParameterCutype
) – The type ofICalGLib.Parameter
to be created- Returns:
The newly created
ICalGLib.Parameter
.- Return type:
New in version 1.0.
- classmethod new_delegatedfrom(v)¶
- Parameters:
v (
str
) – The string used to create the newICalGLib.Parameter
- Returns:
The newly created
ICalGLib.Parameter
.- Return type:
New in version 1.0.
- classmethod new_delegatedto(v)¶
- Parameters:
v (
str
) – The string used to create the newICalGLib.Parameter
- Returns:
The newly created
ICalGLib.Parameter
.- Return type:
New in version 1.0.
- classmethod new_dir(v)¶
- Parameters:
v (
str
) – The string used to create the newICalGLib.Parameter
- Returns:
The newly created
ICalGLib.Parameter
.- Return type:
New in version 1.0.
- classmethod new_display(value)¶
- Parameters:
value (
ICalGLib.ParameterDisplay
) – TheICalGLib.ParameterDisplay
value of the newICalGLib.Parameter
- Returns:
The newly created
ICalGLib.Parameter
- Return type:
New in version 3.0.15.
- classmethod new_email(value)¶
- Parameters:
value (
str
) – The string value of the newICalGLib.Parameter
- Returns:
The newly created
ICalGLib.Parameter
- Return type:
New in version 3.0.15.
- classmethod new_enable(v)¶
- Parameters:
v (
ICalGLib.ParameterEnable
) – The type ofICalGLib.Parameter
to be created- Returns:
The newly created
ICalGLib.Parameter
.- Return type:
Creates a new
ICalGLib.Parameter
according to the enable type.New in version 1.0.
- classmethod new_encoding(v)¶
- Parameters:
v (
ICalGLib.ParameterEncoding
) – The type ofICalGLib.Parameter
to be created- Returns:
The newly created
ICalGLib.Parameter
.- Return type:
Creates a new
ICalGLib.Parameter
according to the encoding type.New in version 1.0.
- classmethod new_fbtype(v)¶
- Parameters:
v (
ICalGLib.ParameterFbtype
) – The type ofICalGLib.Parameter
to be created- Returns:
The newly created
ICalGLib.Parameter
.- Return type:
Creates a new
ICalGLib.Parameter
according to the fbtype type.New in version 1.0.
- classmethod new_feature(value)¶
- Parameters:
value (
ICalGLib.ParameterFeature
) – TheICalGLib.ParameterFeature
value of the newICalGLib.Parameter
- Returns:
The newly created
ICalGLib.Parameter
- Return type:
New in version 3.0.15.
- classmethod new_filename(v)¶
- Parameters:
v (
str
) – The string used to create the newICalGLib.Parameter
- Returns:
The newly created
ICalGLib.Parameter
.- Return type:
New in version 2.0.
- classmethod new_fmttype(v)¶
- Parameters:
v (
str
) – The string used to create the newICalGLib.Parameter
- Returns:
The newly created
ICalGLib.Parameter
.- Return type:
New in version 1.0.
- classmethod new_from_string(value)¶
- Parameters:
value (
str
) – The string from which theICalGLib.Parameter
is created- Returns:
The newly created $:obj:ICalGLib.Parameter with the properties specified in the value.
- Return type:
Creates a
ICalGLib.Parameter
from a string of form “PARAMNAME=VALUE”.New in version 1.0.
- classmethod new_from_value_string(kind, value)¶
- Parameters:
kind (
ICalGLib.ParameterKind
) – The kind ofICalGLib.Parameter
to be createdvalue (
str
) – The string from whichICalGLib.Parameter
to be created
- Returns:
The newly created
ICalGLib.Parameter
- Return type:
Creates a new
ICalGLib.Parameter
from just the value, the part after the “=”New in version 1.0.
- classmethod new_iana(v)¶
- Parameters:
v (
str
) – The string used to create the newICalGLib.Parameter
- Returns:
The newly created
ICalGLib.Parameter
.- Return type:
New in version 1.0.
- classmethod new_id(v)¶
- Parameters:
v (
str
) – The string used to create the newICalGLib.Parameter
- Returns:
The newly created
ICalGLib.Parameter
.- Return type:
New in version 1.0.
- classmethod new_label(value)¶
- Parameters:
value (
str
) – The string value of the newICalGLib.Parameter
- Returns:
The newly created
ICalGLib.Parameter
- Return type:
New in version 3.0.15.
- classmethod new_language(v)¶
- Parameters:
v (
str
) – The string used to create the newICalGLib.Parameter
- Returns:
The newly created
ICalGLib.Parameter
.- Return type:
New in version 1.0.
- classmethod new_latency(v)¶
- Parameters:
v (
str
) – The string used to create the newICalGLib.Parameter
- Returns:
The newly created
ICalGLib.Parameter
.- Return type:
New in version 1.0.
- classmethod new_local(v)¶
- Parameters:
v (
ICalGLib.ParameterLocal
) – The type ofICalGLib.Parameter
to be created- Returns:
The newly created
ICalGLib.Parameter
.- Return type:
Creates a new
ICalGLib.Parameter
according to the local type.New in version 1.0.
- classmethod new_localize(v)¶
- Parameters:
v (
str
) – The string used to create the newICalGLib.Parameter
- Returns:
The newly created
ICalGLib.Parameter
.- Return type:
New in version 1.0.
- classmethod new_managedid(v)¶
- Parameters:
v (
str
) – The string used to create the newICalGLib.Parameter
- Returns:
The newly created
ICalGLib.Parameter
.- Return type:
New in version 2.0.
- classmethod new_member(v)¶
- Parameters:
v (
str
) – The string used to create the newICalGLib.Parameter
- Returns:
The newly created
ICalGLib.Parameter
.- Return type:
New in version 1.0.
- classmethod new_modified(v)¶
- Parameters:
v (
str
) – The string used to create the newICalGLib.Parameter
- Returns:
The newly created
ICalGLib.Parameter
.- Return type:
New in version 2.0.
- classmethod new_options(v)¶
- Parameters:
v (
str
) – The string used to create the newICalGLib.Parameter
- Returns:
The newly created
ICalGLib.Parameter
.- Return type:
New in version 1.0.
- classmethod new_partstat(v)¶
- Parameters:
v (
ICalGLib.ParameterPartstat
) – The type ofICalGLib.Parameter
to be created- Returns:
The newly created
ICalGLib.Parameter
.- Return type:
Creates a new
ICalGLib.Parameter
according to the partstat type.New in version 1.0.
- classmethod new_patchaction(value)¶
- Parameters:
value (
ICalGLib.ParameterPatchaction
) – TheICalGLib.ParameterPatchaction
value of the newICalGLib.Parameter
- Returns:
The newly created
ICalGLib.Parameter
- Return type:
New in version 3.0.15.
- classmethod new_publiccomment(v)¶
- Parameters:
v (
str
) – The string used to create the newICalGLib.Parameter
- Returns:
The newly created
ICalGLib.Parameter
.- Return type:
New in version 2.0.
- classmethod new_range(v)¶
- Parameters:
v (
ICalGLib.ParameterRange
) – The type ofICalGLib.Parameter
to be created- Returns:
The newly created
ICalGLib.Parameter
.- Return type:
Creates a new
ICalGLib.Parameter
according to the range type.New in version 1.0.
- classmethod new_reason(v)¶
- Parameters:
v (
str
) – The string used to create the newICalGLib.Parameter
- Returns:
The newly created
ICalGLib.Parameter
.- Return type:
New in version 2.0.
- Parameters:
v (
ICalGLib.ParameterRelated
) – The type ofICalGLib.Parameter
to be created- Returns:
The newly created
ICalGLib.Parameter
.- Return type:
Creates a new
ICalGLib.Parameter
according to the related type.New in version 1.0.
- classmethod new_reltype(v)¶
- Parameters:
v (
ICalGLib.ParameterReltype
) – The type ofICalGLib.Parameter
to be created- Returns:
The newly created
ICalGLib.Parameter
.- Return type:
Creates a new
ICalGLib.Parameter
according to the reltype type.New in version 1.0.
- classmethod new_required(v)¶
- Parameters:
v (
ICalGLib.ParameterRequired
) – The type ofICalGLib.Parameter
to be created- Returns:
The newly created
ICalGLib.Parameter
.- Return type:
Creates a new
ICalGLib.Parameter
according to the required type.New in version 2.0.
- classmethod new_response(v)¶
- Parameters:
v (
int
) – The type ofICalGLib.Parameter
to be created- Returns:
The newly created
ICalGLib.Parameter
.- Return type:
Creates a new
ICalGLib.Parameter
according to the response type.New in version 2.0.
- classmethod new_role(v)¶
- Parameters:
v (
ICalGLib.ParameterRole
) – The type ofICalGLib.Parameter
to be created- Returns:
The newly created
ICalGLib.Parameter
.- Return type:
Creates a new
ICalGLib.Parameter
according to the role type.New in version 1.0.
- classmethod new_rsvp(v)¶
- Parameters:
v (
ICalGLib.ParameterRsvp
) – The type ofICalGLib.Parameter
to be created- Returns:
The newly created
ICalGLib.Parameter
.- Return type:
Creates a new
ICalGLib.Parameter
according to the rsvp type.New in version 1.0.
- classmethod new_scheduleagent(v)¶
- Parameters:
v (
ICalGLib.ParameterScheduleagent
) – The type ofICalGLib.Parameter
to be created- Returns:
The newly created
ICalGLib.Parameter
.- Return type:
Creates a new
ICalGLib.Parameter
according to the scheduleagent type.New in version 1.0.
- classmethod new_scheduleforcesend(v)¶
- Parameters:
v (
ICalGLib.ParameterScheduleforcesend
) – The type ofICalGLib.Parameter
to be created- Returns:
The newly created
ICalGLib.Parameter
.- Return type:
Creates a new
ICalGLib.Parameter
according to the scheduleforcesend type.New in version 1.0.
- classmethod new_schedulestatus(v)¶
- Parameters:
v (
str
) – The string used to create the newICalGLib.Parameter
- Returns:
The newly created
ICalGLib.Parameter
.- Return type:
New in version 1.0.
- classmethod new_sentby(v)¶
- Parameters:
v (
str
) – The string used to create the newICalGLib.Parameter
- Returns:
The newly created
ICalGLib.Parameter
.- Return type:
New in version 1.0.
- classmethod new_size(v)¶
- Parameters:
v (
str
) – The string used to create the newICalGLib.Parameter
- Returns:
The newly created
ICalGLib.Parameter
.- Return type:
New in version 2.0.
- classmethod new_stayinformed(v)¶
- Parameters:
v (
ICalGLib.ParameterStayinformed
) – The type ofICalGLib.Parameter
to be created- Returns:
The newly created
ICalGLib.Parameter
.- Return type:
Creates a new
ICalGLib.Parameter
according to the stayinformed type.New in version 2.0.
- classmethod new_substate(v)¶
- Parameters:
v (
ICalGLib.ParameterSubstate
) – The type ofICalGLib.Parameter
to be created- Returns:
The newly created
ICalGLib.Parameter
.- Return type:
Creates a new
ICalGLib.Parameter
according to the substate type.New in version 1.0.
- classmethod new_tzid(v)¶
- Parameters:
v (
str
) – The string used to create the newICalGLib.Parameter
- Returns:
The newly created
ICalGLib.Parameter
.- Return type:
New in version 1.0.
- classmethod new_value(v)¶
- Parameters:
v (
ICalGLib.ParameterValue
) – The type ofICalGLib.Parameter
to be created- Returns:
The newly created
ICalGLib.Parameter
.- Return type:
Creates a new
ICalGLib.Parameter
according to the value type.New in version 1.0.
- classmethod new_x(v)¶
- Parameters:
v (
str
) – The string used to create the newICalGLib.Parameter
- Returns:
The newly created
ICalGLib.Parameter
.- Return type:
New in version 1.0.
- classmethod new_xliccomparetype(v)¶
- Parameters:
v (
ICalGLib.ParameterXliccomparetype
) – The type ofICalGLib.Parameter
to be created- Returns:
The newly created
ICalGLib.Parameter
.- Return type:
Creates a new
ICalGLib.Parameter
according to the xliccomparetype type.New in version 1.0.
- classmethod new_xlicerrortype(v)¶
- Parameters:
v (
ICalGLib.ParameterXlicerrortype
) – The type ofICalGLib.Parameter
to be created- Returns:
The newly created
ICalGLib.Parameter
.- Return type:
Creates a new
ICalGLib.Parameter
according to the xlicerrortype type.New in version 1.0.
- classmethod value_to_value_kind(value)¶
- Parameters:
value (
ICalGLib.ParameterValue
) – AICalGLib.ParameterValue
- Returns:
- Return type:
Converts the
ICalGLib.ParameterValue
toICalGLib.ValueKind
.New in version 1.0.
- as_ical_string()¶
- Returns:
The string representation of the self.
- Return type:
Converts an
ICalGLib.Parameter
to the string representation.New in version 1.0.
- clone()¶
- Returns:
The newly created
ICalGLib.Parameter
with the same properties as the self.- Return type:
Deep clone a
ICalGLib.Parameter
.New in version 1.0.
- get_actionparam()¶
- Returns:
The type of the self
- Return type:
New in version 1.0.
- get_cutype()¶
- Returns:
The property of the self
- Return type:
New in version 1.0.
- get_display()¶
- Returns:
The
ICalGLib.ParameterDisplay
value of the self- Return type:
New in version 3.0.15.
- get_enable()¶
- Returns:
The type of the self
- Return type:
New in version 1.0.
- get_encoding()¶
- Returns:
The type of the self
- Return type:
New in version 1.0.
- get_fbtype()¶
- Returns:
The type of the self
- Return type:
New in version 1.0.
- get_feature()¶
- Returns:
The
ICalGLib.ParameterFeature
value of the self- Return type:
New in version 3.0.15.
- get_iana_name()¶
-
Gets the iana_name property of the native part of the
ICalGLib.Parameter
.New in version 1.0.
- get_iana_value()¶
-
Gets the iana_value property of the native part of the
ICalGLib.Parameter
.New in version 1.0.
- get_local()¶
- Returns:
The type of the self
- Return type:
New in version 1.0.
- get_parent()¶
- Returns:
The parent
ICalGLib.Property
- Return type:
Gets the parent
ICalGLib.Property
of the specifiedICalGLib.Parameter
.New in version 3.0.
- get_partstat()¶
- Returns:
The type of the self
- Return type:
New in version 1.0.
- get_patchaction()¶
- Returns:
The
ICalGLib.ParameterPatchaction
value of the self- Return type:
New in version 3.0.15.
- get_range()¶
- Returns:
The type of the self
- Return type:
New in version 1.0.
- Returns:
The type of the self
- Return type:
New in version 1.0.
- get_reltype()¶
- Returns:
The type of the self
- Return type:
New in version 1.0.
- get_required()¶
- Returns:
The type of the self
- Return type:
New in version 2.0.
- get_role()¶
- Returns:
The type of the self
- Return type:
New in version 1.0.
- get_rsvp()¶
- Returns:
The type of the self
- Return type:
New in version 1.0.
- get_scheduleagent()¶
- Returns:
The type of the self
- Return type:
New in version 1.0.
- get_scheduleforcesend()¶
- Returns:
The type of the self
- Return type:
New in version 1.0.
- get_schedulestatus()¶
-
New in version 1.0.
- get_stayinformed()¶
- Returns:
The type of the self
- Return type:
New in version 2.0.
- get_substate()¶
- Returns:
The type of the self
- Return type:
New in version 1.0.
- get_value()¶
- Returns:
The type of the self
- Return type:
New in version 1.0.
- get_xliccomparetype()¶
- Returns:
The type of the self
- Return type:
New in version 1.0.
- get_xlicerrortype()¶
- Returns:
The type of the self
- Return type:
New in version 1.0.
- get_xname()¶
-
Gets the xname property of the native part of the
ICalGLib.Parameter
.New in version 1.0.
- get_xvalue()¶
-
Gets the xvalue property of the native part of the
ICalGLib.Parameter
.New in version 1.0.
- has_same_name(param2)¶
- Parameters:
param2 (
ICalGLib.Parameter
) – TheICalGLib.Parameter
to be checked- Returns:
1 if the parameters have the same name, 0 or not.
- Return type:
Checks whether native parts of two
ICalGLib.Parameters
have the same name.New in version 1.0.
- isa()¶
- Returns:
The type of the self.
- Return type:
Checks the type of a
ICalGLib.Parameter
.New in version 1.0.
- isa_parameter()¶
- Returns:
1 if the native part is of type icalparameter, 0 if not.
- Return type:
Checks whether the native part of the
ICalGLib.Parameter
is of type icalparameter.New in version 1.0.
- set_actionparam(v)¶
- Parameters:
v (
ICalGLib.ParameterAction
) – The type ofICalGLib.Parameter
to be set in the self
New in version 1.0.
- set_cutype(v)¶
- Parameters:
v (
ICalGLib.ParameterCutype
) – The ICalParameterCutype used to set self
New in version 1.0.
- set_delegatedfrom(v)¶
- Parameters:
v (
str
) – The string used to set into the self
New in version 1.0.
- set_display(value)¶
- Parameters:
value (
ICalGLib.ParameterDisplay
) – TheICalGLib.ParameterDisplay
to set into the self
New in version 3.0.15.
- set_email(value)¶
- Parameters:
value (
str
) – The string value to set into the self
New in version 3.0.15.
- set_enable(v)¶
- Parameters:
v (
ICalGLib.ParameterEnable
) – The type ofICalGLib.Parameter
to be set in the self
New in version 1.0.
- set_encoding(v)¶
- Parameters:
v (
ICalGLib.ParameterEncoding
) – The type ofICalGLib.Parameter
to be set in the self
New in version 1.0.
- set_fbtype(v)¶
- Parameters:
v (
ICalGLib.ParameterFbtype
) – The type ofICalGLib.Parameter
to be set in the self
New in version 1.0.
- set_feature(value)¶
- Parameters:
value (
ICalGLib.ParameterFeature
) – TheICalGLib.ParameterFeature
to set into the self
New in version 3.0.15.
- set_iana_name(v)¶
- Parameters:
v (
str
) – The name to be set into the self
Sets the iana_name property of the native part of the
ICalGLib.Parameter
.New in version 1.0.
- set_iana_value(v)¶
- Parameters:
v (
str
) – The value to be set into the self
Sets the iana_value property of the native part of the
ICalGLib.Parameter
.New in version 1.0.
- set_label(value)¶
- Parameters:
value (
str
) – The string value to set into the self
New in version 3.0.15.
- set_local(v)¶
- Parameters:
v (
ICalGLib.ParameterLocal
) – The type ofICalGLib.Parameter
to be set in the self
New in version 1.0.
- set_parent(property)¶
- Parameters:
property (
ICalGLib.Property
orNone
) – The parentICalGLib.Property
Sets the parent
ICalGLib.Property
of anICalGLib.Parameter
.New in version 3.0.
- set_partstat(v)¶
- Parameters:
v (
ICalGLib.ParameterPartstat
) – The type ofICalGLib.Parameter
to be set in the self
New in version 1.0.
- set_patchaction(value)¶
- Parameters:
value (
ICalGLib.ParameterPatchaction
) – TheICalGLib.ParameterPatchaction
to set into the self
New in version 3.0.15.
- set_publiccomment(v)¶
- Parameters:
v (
str
) – The string used to set into the self
New in version 2.0.
- set_range(v)¶
- Parameters:
v (
ICalGLib.ParameterRange
) – The type ofICalGLib.Parameter
to be set in the self
New in version 1.0.
- Parameters:
v (
ICalGLib.ParameterRelated
) – The type ofICalGLib.Parameter
to be set in the self
New in version 1.0.
- set_reltype(v)¶
- Parameters:
v (
ICalGLib.ParameterReltype
) – The type ofICalGLib.Parameter
to be set in the self
New in version 1.0.
- set_required(v)¶
- Parameters:
v (
ICalGLib.ParameterRequired
) – The type ofICalGLib.Parameter
to be set in the self
New in version 2.0.
- set_response(v)¶
- Parameters:
v (
int
) – The type ofICalGLib.Parameter
to be set in the self
New in version 2.0.
- set_role(v)¶
- Parameters:
v (
ICalGLib.ParameterRole
) – The type ofICalGLib.Parameter
to be set in the self
New in version 1.0.
- set_rsvp(v)¶
- Parameters:
v (
ICalGLib.ParameterRsvp
) – The type ofICalGLib.Parameter
to be set in the self
New in version 1.0.
- set_scheduleagent(v)¶
- Parameters:
v (
ICalGLib.ParameterScheduleagent
) – The type ofICalGLib.Parameter
to be set in the self
New in version 1.0.
- set_scheduleforcesend(v)¶
- Parameters:
v (
ICalGLib.ParameterScheduleforcesend
) – The type ofICalGLib.Parameter
to be set in the self
New in version 1.0.
- set_schedulestatus(v)¶
- Parameters:
v (
str
) – The string used to set into the self
New in version 1.0.
- set_stayinformed(v)¶
- Parameters:
v (
ICalGLib.ParameterStayinformed
) – The type ofICalGLib.Parameter
to be set in the self
New in version 2.0.
- set_substate(v)¶
- Parameters:
v (
ICalGLib.ParameterSubstate
) – The type ofICalGLib.Parameter
to be set in the self
New in version 1.0.
- set_value(v)¶
- Parameters:
v (
ICalGLib.ParameterValue
) – The type ofICalGLib.Parameter
to be set in the self
New in version 1.0.
- set_xliccomparetype(v)¶
- Parameters:
v (
ICalGLib.ParameterXliccomparetype
) – The type ofICalGLib.Parameter
to be set in the self
New in version 1.0.
- set_xlicerrortype(v)¶
- Parameters:
v (
ICalGLib.ParameterXlicerrortype
) – The type ofICalGLib.Parameter
to be set in the self
New in version 1.0.
- set_xname(v)¶
- Parameters:
v (
str
) – The name to be set into the self
Sets the xname property of the native part of the
ICalGLib.Parameter
.New in version 1.0.
- set_xvalue(v)¶
- Parameters:
v (
str
) – The value to be set into the self
Sets the xvalue property of the native part of the
ICalGLib.Parameter
.New in version 1.0.