vobject.icalendar.VAlarm

Package vobject :: Module icalendar :: Class VAlarm

[show private | hide private]

Type VAlarm

object --+    
         |    
  Behavior --+
             |
            VAlarm

Alarm behavior.

Method Summary
	`generateImplicitParameters(obj)` Create default ACTION and TRIGGER if they're not set. (Static method)
	`validate(cls, obj, raiseException, args)` #TODO... (Class method)*
Inherited from Behavior
	`__init__(self)`
	`decode(cls, line)` (Class method)
	`encode(cls, line)` (Class method)
	`lineValidate(cls, line, raiseException, complainUnrecognized)` Examine a line's parameters and values, return True if valid. (Class method)
	`serialize(cls, obj, buf, lineLength)` Set implicit parameters, do encoding, return unicode string. (Class method)
	`transformFromNative(cls, obj)` Inverse of transformToNative. (Class method)
	`transformToNative(cls, obj)` Turn a ContentLine or Component into a Python-native representation. (Class method)
Inherited from object
	`__delattr__(...)` x.__delattr__('name') <==> del x.name
	`__getattribute__(...)` x.__getattribute__('name') <==> x.name
	`__hash__(x)` x.__hash__() <==> hash(x)
	`__new__(T, S, ...)` T.__new__(S, ...) -> a new object with type S, a subtype of T
	`__reduce__(...)` helper for pickle
	`__reduce_ex__(...)` helper for pickle
	`__repr__(x)` x.__repr__() <==> repr(x)
	`__setattr__(...)` x.__setattr__('name', value) <==> x.name = value
	`__str__(x)` x.__str__() <==> str(x)

Class Variable Summary
`str`	`description`: A brief excerpt from the RFC explaining the function of the component or line.
`bool`	`isComponent`: A boolean, True if the object should be a Component.
`dict`	`knownChildren`: A dictionary with uppercased component/property names as keys and a tuple (min, max, id) as value, where id is the id used by `registerBehavior`, min and max are the limits on how many of this child must occur.
`str`	`name`: The uppercase name of the object described by the class, or a generic name if the class defines behavior for many objects.
Inherited from Behavior
`bool`	`allowGroup`: Whether or not vCard style group prefixes are allowed.
`bool`	`hasNative`: A boolean describing whether the object can be transformed into a more Pythonic object.
`bool`	`quotedPrintable`: A boolean describing whether the object should be encoded and decoded using quoted printable line folding and character escaping.
`list`	`sortFirst`: The lower-case list of children which should come first when sorting.
`str`	`versionString`: The string associated with the component, for instance, 2.0 if there's a line like VERSION:2.0, an empty string otherwise.

Static Method Details

generateImplicitParameters(obj)

Create default ACTION and TRIGGER if they're not set.

Overrides:: __builtin__.type.generateImplicitParameters

Class Method Details

validate(cls, obj, raiseException, *args)

#TODO
audioprop  = 2*(

           ; 'action' and 'trigger' are both REQUIRED,
           ; but MUST NOT occur more than once

           action / trigger /

           ; 'duration' and 'repeat' are both optional,
           ; and MUST NOT occur more than once each,
           ; but if one occurs, so MUST the other

           duration / repeat /

           ; the following is optional,
           ; but MUST NOT occur more than once

           attach /

dispprop   = 3*(

           ; the following are all REQUIRED,
           ; but MUST NOT occur more than once

           action / description / trigger /

           ; 'duration' and 'repeat' are both optional,
           ; and MUST NOT occur more than once each,
           ; but if one occurs, so MUST the other

           duration / repeat /

emailprop  = 5*(

           ; the following are all REQUIRED,
           ; but MUST NOT occur more than once

           action / description / trigger / summary

           ; the following is REQUIRED,
           ; and MAY occur more than once

           attendee /

           ; 'duration' and 'repeat' are both optional,
           ; and MUST NOT occur more than once each,
           ; but if one occurs, so MUST the other

           duration / repeat /

procprop   = 3*(

           ; the following are all REQUIRED,
           ; but MUST NOT occur more than once

           action / attach / trigger /

           ; 'duration' and 'repeat' are both optional,
           ; and MUST NOT occur more than once each,
           ; but if one occurs, so MUST the other

           duration / repeat /

           ; 'description' is optional,
           ; and MUST NOT occur more than once

           description /
   if obj.contents.has_key('DTEND') and obj.contents.has_key('DURATION'):
       if raiseException:
           m = "VEVENT components cannot contain both DTEND and DURATION                     components"
           raise ValidateError(m)
       return False
   else:
       return super(VEvent, cls).validate(obj, raiseException, *args)

Overrides:: __builtin__.type.validate

Class Variable Details

description

A brief excerpt from the RFC explaining the function of the component or line.

Type:: str
Value:: 'Alarms describe when and how to provide alerts about events \ and to-dos.'

isComponent

A boolean, True if the object should be a Component.

Type:: bool
Value:: True

knownChildren

A dictionary with uppercased component/property names as keys and a tuple (min, max, id) as value, where id is the id used by registerBehavior, min and max are the limits on how many of this child must occur. None is used to denote no max or no id.

Type:: dict
Value:: {'ACTION': (1, 1, None), 'DESCRIPTION': (0, 1, None), 'DURATION': (0, 1, None), 'REPEAT': (0, 1, None), 'TRIGGER': (1, 1, None)}

name

The uppercase name of the object described by the class, or a generic name if the class defines behavior for many objects.

Type:: str
Value:: 'VALARM'

Generated by Epydoc 2.1 on Fri Dec 14 17:25:14 2007

http://epydoc.sf.net