README
¶
ics
-- import "github.com/MJKWoolnough/ics"
Package ics implements an encoder and decoder for iCalendar files
Usage
var (
ErrInvalidParam = errors.New("invalid param value")
ErrInvalidValue = errors.New("invalid value")
)
Errors
var (
ErrMultipleSingle = errors.New("unique property found multiple times")
ErrInvalidEnd = errors.New("invalid end of section")
ErrMissingRequired = errors.New("required property missing")
ErrRequirementNotMet = errors.New("requirement not met")
)
Errors
var (
ErrInvalidStructure = errors.New("invalid structure")
ErrMissingAlarmAction = errors.New("missing alarm action")
ErrInvalidAlarm = errors.New("invalid alarm type")
)
Errors
var (
ErrInvalidContentLine = errors.New("invalid content line")
ErrInvalidContentLineName = errors.New("invalid content line name")
ErrInvalidContentLineParamName = errors.New("invalid content line param name")
ErrInvalidContentLineQuotedParamValue = errors.New("invalid content line quoted param value")
ErrInvalidContentLineParamValue = errors.New("invalid content line param value")
ErrInvalidContentLineValue = errors.New("invalid content line value")
)
Errors
var (
ErrInvalidEncoding = errors.New("invalid Binary encoding")
ErrInvalidPeriod = errors.New("invalid Period")
ErrInvalidDuration = errors.New("invalid Duration")
ErrInvalidText = errors.New("invalid encoded text")
ErrInvalidBoolean = errors.New("invalid Boolean")
ErrInvalidOffset = errors.New("invalid UTC Offset")
ErrInvalidRecur = errors.New("invalid Recur")
ErrInvalidTime = errors.New("invalid time")
ErrInvalidFloat = errors.New("invalid float")
ErrInvalidTFloat = errors.New("invalid number of floats")
ErrInvalidPeriodStart = errors.New("invalid start of Period")
ErrInvalidPeriodDuration = errors.New("invalid Period duration")
ErrInvalidPeriodEnd = errors.New("invalid end of Period")
ErrInvalidRecurFrequency = errors.New("invalid Recur frequency")
ErrInvalidRecurBySecond = errors.New("invalid Recur BySecond")
ErrInvalidRecurByMinute = errors.New("invalid Recur ByMinute")
ErrInvalidRecurByHour = errors.New("invalid Recur ByHour")
ErrInvalidRecurByDay = errors.New("invalid Recur ByDay")
ErrInvalidRecurByMonthDay = errors.New("invalid Recur ByMonthDay")
ErrInvalidRecurByYearDay = errors.New("invalid Recur ByYearDay")
ErrInvalidRecurByWeekNum = errors.New("invalid Recur ByWeekNum")
ErrInvalidRecurByMonth = errors.New("invalid Recur ByMonth")
ErrInvalidRecurBySetPos = errors.New("invalid Recur BySetPos")
ErrInvalidRecurWeekStart = errors.New("invalid Recur WeekStart")
)
Errors
var (
ErrDuplicateParam = errors.New("duplicate param")
)
Errors
var (
ErrInvalidCalendar = errors.New("invalid calendar")
)
Errors
func Encode
func Encode(w io.Writer, cal *Calendar) error
Encode encodes the given iCalendar object into the writer. It first validates the iCalendar object so as not to write invalid data to the writer
type Alarm
type Alarm struct {
AlarmType
}
Alarm is the encompassing type for the three alarm types
type AlarmAudio
type AlarmAudio struct {
Trigger PropTrigger
Duration *PropDuration
Repeat *PropRepeat
Attachment []PropAttachment
}
AlarmAudio provides a group of components that define an Audio Alarm
func (AlarmAudio) Type
func (AlarmAudio) Type() string
Type returns the type of the alarm "AUDIO"
type AlarmDisplay
type AlarmDisplay struct {
Description PropDescription
Trigger PropTrigger
Duration *PropDuration
Repeat *PropRepeat
}
AlarmDisplay provides a group of components that define a Display Alarm
func (AlarmDisplay) Type
func (AlarmDisplay) Type() string
Type returns the type of the alarm "DISPLAY"
type AlarmEmail
type AlarmEmail struct {
Description PropDescription
Trigger PropTrigger
Summary PropSummary
Attendee *PropAttendee
Duration *PropDuration
Repeat *PropRepeat
}
AlarmEmail provides a group of components that define an Email Alarm
func (AlarmEmail) Type
func (AlarmEmail) Type() string
Type returns the type of the alarm "EMAIL"
type AlarmType
type AlarmType interface {
Type() string
// contains filtered or unexported methods
}
AlarmType is an interface this is fulfilled by AlarmAudio, AlarmDisplay and AlarmEmail
type AlternativeRepresentation
type AlternativeRepresentation URI
AlternativeRepresentation is an alternate text representation for the property value
type Binary
type Binary []byte
Binary is inline binary data
type Boolean
type Boolean bool
Boolean is true or false
type Calendar
type Calendar struct {
Version PropVersion
ProdID PropProdID
Event []Event
Todo []Todo
Journal []Journal
FreeBusy []FreeBusy
Timezone []Timezone
}
Calendar represents a iCalendar object
func Decode
func Decode(r io.Reader) (*Calendar, error)
Decode decodes an iCalendar object from the given reader
type CalendarAddress
type CalendarAddress struct {
url.URL
}
CalendarAddress contains a calendar user address
type CalendarUserType
type CalendarUserType uint8
CalendarUserType is identify the type of calendar user specified by the property
const (
CalendarUserTypeUnknown CalendarUserType = iota
CalendarUserTypeIndividual
CalendarUserTypeGroup
CalendarUserTypeResource
CalendarUserTypeRoom
)
CalendarUserType constant values
func (CalendarUserType) New
func (t CalendarUserType) New() *CalendarUserType
New returns a pointer to the type (used with constants for ease of use with optional values)
type CommonName
type CommonName string
CommonName is the common name to be associated with the calendar user specified by the property
func NewCommonName
func NewCommonName(v CommonName) *CommonName
NewCommonName returns a *CommonName for ease of use with optional values
type Date
type Date struct {
time.Time
}
Date is a Calendar Data
type DateTime
type DateTime struct {
time.Time
}
DateTime is a Calendar Date and Time
type DayRecur
type DayRecur struct {
Day WeekDay
Occurence int8
}
DayRecur is used to reprent the nth day in a time period, be it 2nd Monday in a Month, or 31st Friday in a year, etc.
type Daylight
type Daylight struct {
DateTimeStart PropDateTimeStart
TimezoneOffsetTo PropTimezoneOffsetTo
TimezoneOffsetFrom PropTimezoneOffsetFrom
RecurrenceRule *PropRecurrenceRule
Comment []PropComment
RecurrenceDateTimes []PropRecurrenceDateTimes
TimezoneName []PropTimezoneName
}
Daylight represents daylight savings timezone rules
type Delagatee
type Delagatee []CalendarAddress
Delagatee is used to specify the calendar users to whom the calendar user specified by the property has delegated participation
type Delegator
type Delegator []CalendarAddress
Delegator is used to specify the calendar users that have delegated their participation to the calendar user specified by the property
type DirectoryEntry
type DirectoryEntry string
DirectoryEntry is a reference to a directory entry associated with the calendar
func NewDirectoryEntry
func NewDirectoryEntry(v DirectoryEntry) *DirectoryEntry
NewDirectoryEntry returns a *DirectoryEntry for ease of use with optional values
type Duration
type Duration struct {
Negative bool
Weeks, Days, Hours, Minutes, Seconds uint
}
Duration is a duration of time
type Encoding
type Encoding uint8
Encoding is the inline encoding for the property value
const (
Encoding8bit Encoding = iota
EncodingBase64
)
Encoding constant values
func (Encoding) New
func (t Encoding) New() *Encoding
New returns a pointer to the type (used with constants for ease of use with optional values)
type Event
type Event struct {
DateTimeStamp PropDateTimeStamp
UID PropUID
DateTimeStart *PropDateTimeStart
Class *PropClass
Created *PropCreated
Description *PropDescription
Geo *PropGeo
LastModified *PropLastModified
Location *PropLocation
Organizer *PropOrganizer
Priority *PropPriority
Sequence *PropSequence
Status *PropStatus
Summary *PropSummary
TimeTransparency *PropTimeTransparency
URL *PropURL
RecurrenceID *PropRecurrenceID
RecurrenceRule *PropRecurrenceRule
DateTimeEnd *PropDateTimeEnd
Duration *PropDuration
Attachment []PropAttachment
Attendee []PropAttendee
Categories []PropCategories
Comment []PropComment
Contact []PropContact
ExceptionDateTime []PropExceptionDateTime
RequestStatus []PropRequestStatus
RelatedTo []PropRelatedTo
Resources []PropResources
RecurrenceDateTimes []PropRecurrenceDateTimes
Alarm []Alarm
}
Event provides a group of components that describe an event
type Float
type Float float64
Float contains a real-number value
type FormatType
type FormatType string
FormatType is the content type of a referenced object
func NewFormatType
func NewFormatType(v FormatType) *FormatType
NewFormatType returns a *FormatType for ease of use with optional values
type FreeBusy
type FreeBusy struct {
DateTimeStamp PropDateTimeStamp
UID PropUID
Contact *PropContact
DateTimeStart *PropDateTimeStart
DateTimeEnd *PropDateTimeEnd
Organizer *PropOrganizer
URL *PropURL
Attendee []PropAttendee
Comment []PropComment
FreeBusy []PropFreeBusy
RequestStatus []PropRequestStatus
}
FreeBusy provides a group of components that describe either a request for free/busy time, describe a response to a request for free/busy time, or describe a published set of busy time
type FreeBusyType
type FreeBusyType uint8
FreeBusyType is used to specify the free or busy time type
const (
FreeBusyTypeUnknown FreeBusyType = iota
FreeBusyTypeFree
FreeBusyTypeBusy
FreeBusyTypeBusyUnavailable
FreeBusyTypeBusyTentative
)
FreeBusyType constant values
func (FreeBusyType) New
func (t FreeBusyType) New() *FreeBusyType
New returns a pointer to the type (used with constants for ease of use with optional values)
type Frequency
type Frequency uint8
Frequency represents the Recurrence frequency
const (
Secondly Frequency = iota
Minutely
Hourly
Daily
Weekly
Monthly
Yearly
)
Frequency constant values
type Integer
type Integer int32
Integer is a signed integer value
type Journal
type Journal struct {
DateTimeStamp PropDateTimeStamp
UID PropUID
Class *PropClass
Created *PropCreated
DateTimeStart *PropDateTimeStart
LastModified *PropLastModified
Organizer *PropOrganizer
RecurrenceID *PropRecurrenceID
Sequence *PropSequence
Status *PropStatus
Summary *PropSummary
URL *PropURL
RecurrenceRule *PropRecurrenceRule
Attachment []PropAttachment
Attendee []PropAttendee
Categories []PropCategories
Comment []PropComment
Contact []PropContact
Description []PropDescription
ExceptionDateTime []PropExceptionDateTime
RequestStatus []PropRequestStatus
RelatedTo []PropRelatedTo
Resources []PropResources
RecurrenceDateTimes []PropRecurrenceDateTimes
}
Journal provides a group of components that describe a journal entry
type Language
type Language string
Language is the language for text values
func NewLanguage
func NewLanguage(v Language) *Language
NewLanguage returns a *Language for ease of use with optional values
type MText
type MText []Text
MText contains multiple text values
type Member
type Member []string
Member is used to specify the group or list membership of the calendar
func NewMember
func NewMember(v Member) *Member
NewMember returns a *Member for ease of use with optional values
type Month
type Month uint8
Month is a numeric representation of a Month of the Year
const (
UnknownMonth Month = iota
January
February
March
April
May
June
July
August
September
October
November
December
)
Month Constant Values
type ParticipationRole
type ParticipationRole uint8
ParticipationRole is used to specify the participation role for the calendar user specified by the property
const (
ParticipationRoleUnknown ParticipationRole = iota
ParticipationRoleRequiredParticipant
ParticipationRoleChair
ParticipationRoleOptParticipant
ParticipationRoleNonParticipant
)
ParticipationRole constant values
func (ParticipationRole) New
func (t ParticipationRole) New() *ParticipationRole
New returns a pointer to the type (used with constants for ease of use with optional values)
type ParticipationStatus
type ParticipationStatus uint8
ParticipationStatus is used to specify the participation status for the calendar
const (
ParticipationStatusUnknown ParticipationStatus = iota
ParticipationStatusNeedsAction
ParticipationStatusAccepted
ParticipationStatusDeclined
ParticipationStatusTentative
ParticipationStatusDelegated
ParticipationStatusCompleted
ParticipationStatusInProcess
)
ParticipationStatus constant values
func (ParticipationStatus) New
func (t ParticipationStatus) New() *ParticipationStatus
New returns a pointer to the type (used with constants for ease of use with optional values)
type Period
type Period struct {
Start, End DateTime
Duration Duration
}
Period represents a precise period of time/
Only one of End or Duration will be used. If Period.End.IsZero() is true, then it uses Period.Duration
type PropAction
type PropAction uint8
PropAction defines the action to be invoked when an alarm is triggered
const (
ActionAudio PropAction = iota
ActionDisplay
ActionEmail
)
PropAction constant values
func (PropAction) New
func (p PropAction) New() *PropAction
New returns a pointer to the type (used with constants for ease of use with optional values)
type PropAttachment
type PropAttachment struct {
FormatType *FormatType
URI *URI
Binary *Binary
}
PropAttachment provides the capability to associate a document object with a calendar component
type PropAttendee
type PropAttendee struct {
CalendarUserType *CalendarUserType
Member Member
ParticipationRole *ParticipationRole
ParticipationStatus *ParticipationStatus
RSVP *RSVP
Delagatee Delagatee
Delegator Delegator
SentBy *SentBy
CommonName *CommonName
DirectoryEntry *DirectoryEntry
Language *Language
CalendarAddress
}
PropAttendee defines an "Attendee" within a calendar component
type PropCalendarScale
type PropCalendarScale uint8
PropCalendarScale defines the calendar scale
const (
CalendarScaleGregorian PropCalendarScale = iota
)
PropCalendarScale constant values
func (PropCalendarScale) New
func (p PropCalendarScale) New() *PropCalendarScale
New returns a pointer to the type (used with constants for ease of use with optional values)
type PropCategories
type PropCategories struct {
Language *Language
MText
}
PropCategories defines the categories for a calendar component
type PropClass
type PropClass uint8
PropClass defines the access classification for a calendar component
const (
ClassPublic PropClass = iota
ClassPrivate
ClassConfidential
)
PropClass constant values
func (PropClass) New
func (p PropClass) New() *PropClass
New returns a pointer to the type (used with constants for ease of use with optional values)
type PropComment
type PropComment struct {
AlternativeRepresentation *AlternativeRepresentation
Language *Language
Text
}
PropComment specifies non-processing information intended to provide a comment to the calendar user
type PropCompleted
type PropCompleted DateTime
PropCompleted defines the date and time that a to-do was actually completed
type PropContact
type PropContact struct {
AlternativeRepresentation *AlternativeRepresentation
Language *Language
Text
}
PropContact is used to represent contact information or alternately a reference to contact information associated with the calendar component
type PropCreated
type PropCreated DateTime
PropCreated specifies the date and time that the calendar information was created by the calendar user agent in the calendar store
type PropDateTimeEnd
type PropDateTimeEnd struct {
DateTime *DateTime
Date *Date
}
PropDateTimeEnd specifies the date and time that a calendar component ends
type PropDateTimeStamp
type PropDateTimeStamp DateTime
PropDateTimeStamp specifies the date and time that the calendar object was created unless the calendar object has no METHOD property, in which case it specifies the date and time that the information with the calendar was last revised
type PropDateTimeStart
type PropDateTimeStart struct {
DateTime *DateTime
Date *Date
}
PropDateTimeStart specifies when the calendar component begins
type PropDescription
type PropDescription struct {
AlternativeRepresentation *AlternativeRepresentation
Language *Language
Text
}
PropDescription provides a more complete description of the calendar component than that provided by the "SUMMARY" property
type PropDue
type PropDue struct {
DateTime *DateTime
Date *Date
}
PropDue defines the date and time that a to-do is expected to be completed
type PropDuration
type PropDuration Duration
PropDuration specifies a positive duration of time
type PropExceptionDateTime
type PropExceptionDateTime struct {
DateTime *DateTime
Date *Date
}
PropExceptionDateTime defines the list of DATE-TIME exceptions for recurring events, to-dos, journal entries, or time zone definitions
type PropFreeBusy
type PropFreeBusy struct {
FreeBusyType *FreeBusyType
Period
}
PropFreeBusy defines one or more free or busy time intervals
type PropGeo
type PropGeo TFloat
PropGeo specifies information related to the global position for the activity specified by a calendar component
type PropLastModified
type PropLastModified DateTime
PropLastModified specifies the date and time that the information associated with the calendar component was last revised in the calendar store
type PropLocation
type PropLocation struct {
AlternativeRepresentation *AlternativeRepresentation
Language *Language
Text
}
PropLocation defines the intended venue for the activity defined by a calendar component
type PropMethod
type PropMethod Text
PropMethod defines the iCalendar object method associated with the calendar object
type PropOrganizer
type PropOrganizer struct {
CommonName *CommonName
DirectoryEntry *DirectoryEntry
SentBy *SentBy
Language *Language
CalendarAddress
}
PropOrganizer defines the organizer for a calendar component
type PropPercentComplete
type PropPercentComplete Integer
PropPercentComplete is used by an assignee or delegatee of a to-do to convey the percent completion of a to-do to the "Organizer"
func NewPercentComplete
func NewPercentComplete(v PropPercentComplete) *PropPercentComplete
NewPercentComplete generates a pointer to a constant value. Used when manually creating Calendar values
type PropPriority
type PropPriority Integer
PropPriority defines the relative priority for a calendar component
func NewPriority
func NewPriority(v PropPriority) *PropPriority
NewPriority generates a pointer to a constant value. Used when manually creating Calendar values
type PropProdID
type PropProdID Text
PropProdID specifies the identifier for the product that created the iCalendar object
type PropRecurrenceDateTimes
type PropRecurrenceDateTimes struct {
DateTime *DateTime
Date *Date
Period *Period
}
PropRecurrenceDateTimes defines the list of DATE-TIME values for recurring events, to-dos, journal entries, or time zone definitions
type PropRecurrenceID
type PropRecurrenceID struct {
Range *Range
DateTime *DateTime
Date *Date
}
PropRecurrenceID is used to identify a specific instance of a recurring Event, Todo or Journal
type PropRecurrenceRule
type PropRecurrenceRule Recur
PropRecurrenceRule defines a rule or repeating pattern for recurring events, to-dos, journal entries, or time zone definitions
type PropRelatedTo
type PropRelatedTo struct {
RelationshipType *RelationshipType
Text
}
PropRelatedTo is used to represent a relationship or reference between one calendar component and another
type PropRepeat
type PropRepeat Integer
PropRepeat defines the number of times the alarm should be repeated, after the initial trigger
func NewRepeat
func NewRepeat(v PropRepeat) *PropRepeat
NewRepeat generates a pointer to a constant value. Used when manually creating Calendar values
type PropRequestStatus
type PropRequestStatus Text
PropRequestStatus defines the status code returned for a scheduling request
type PropResources
type PropResources struct {
AlternativeRepresentation *AlternativeRepresentation
Language *Language
MText
}
PropResources defines the equipment or resources anticipated for an activity specified by a calendar component
type PropSequence
type PropSequence Integer
PropSequence defines the revision sequence number of the calendar component within a sequence of revisions
func NewSequence
func NewSequence(v PropSequence) *PropSequence
NewSequence generates a pointer to a constant value. Used when manually creating Calendar values
type PropStatus
type PropStatus uint8
PropStatus defines the overall status or confirmation for the calendar component
const (
StatusTentative PropStatus = iota
StatusConfirmed
StatusCancelled
StatusNeedsAction
StatusCompleted
StatusInProcess
StatusDraft
StatusFinal
)
PropStatus constant values
func (PropStatus) New
func (p PropStatus) New() *PropStatus
New returns a pointer to the type (used with constants for ease of use with optional values)
type PropSummary
type PropSummary struct {
AlternativeRepresentation *AlternativeRepresentation
Language *Language
Text
}
PropSummary defines a short summary or subject for the calendar component
type PropTimeTransparency
type PropTimeTransparency uint8
PropTimeTransparency defines whether or not an event is transparent to busy time searches
const (
TimeTransparencyOpaque PropTimeTransparency = iota
TimeTransparencyTransparent
)
PropTimeTransparency constant values
func (PropTimeTransparency) New
func (p PropTimeTransparency) New() *PropTimeTransparency
New returns a pointer to the type (used with constants for ease of use with optional values)
type PropTimezoneID
type PropTimezoneID Text
PropTimezoneID specifies the text value that uniquely identifies the "VTIMEZONE" calendar component in the scope of an iCalendar object
type PropTimezoneName
type PropTimezoneName struct {
Language *Language
Text
}
PropTimezoneName specifies the customary designation for a time zone description
type PropTimezoneOffsetFrom
type PropTimezoneOffsetFrom UTCOffset
PropTimezoneOffsetFrom specifies the offset that is in use prior to this time zone observance
type PropTimezoneOffsetTo
type PropTimezoneOffsetTo UTCOffset
PropTimezoneOffsetTo specifies the offset that is in use in this time zone observance
type PropTimezoneURL
type PropTimezoneURL URI
PropTimezoneURL provides a means for a "VTIMEZONE" component to point to a network location that can be used to retrieve an up- to-date version of itself
type PropTrigger
type PropTrigger struct {
Duration *Duration
DateTime *DateTime
}
PropTrigger specifies when an alarm will trigger
type PropUID
type PropUID Text
PropUID defines the persistent, globally unique identifier for the calendar component
type PropURL
type PropURL URI
PropURL defines a Uniform Resource Locator associated with the iCalendar object
type PropVersion
type PropVersion Text
PropVersion specifies the identifier corresponding to the highest version number or the minimum and maximum range of the iCalendar specification that is required in order to interpret the iCalendar object
type RSVP
type RSVP Boolean
RSVP is used to specify whether there is an expectation of a favor of a reply from the calendar user specified by the property value
func NewRSVP
func NewRSVP(v RSVP) *RSVP
NewRSVP returns a *RSVP for ease of use with optional values
type Range
type Range struct{}
Range is used to specify the effective range of recurrence instances from the instance specified by the recurrence identifier specified by the property
type Recur
type Recur struct {
Frequency Frequency
Until time.Time
UntilTime bool
Count uint64
Interval uint64
BySecond []uint8
ByMinute []uint8
ByHour []uint8
ByDay []DayRecur
ByMonthDay []int8
ByYearDay []int16
ByWeekNum []int8
ByMonth []Month
BySetPos []int16
WeekStart WeekDay
}
Recur contains a recurrence rule specification
type Related
type Related uint8
Related is the relationship of the alarm trigger with respect to the start or end of the calendar component
const (
RelatedStart Related = iota
RelatedEnd
)
Related constant values
func (Related) New
func (t Related) New() *Related
New returns a pointer to the type (used with constants for ease of use with optional values)
type RelationshipType
type RelationshipType uint8
RelationshipType is the type of hierarchical relationship associated with the calendar component specified by the property
const (
RelationshipTypeUnknown RelationshipType = iota
RelationshipTypeParent
RelationshipTypeChild
RelationshipTypeSibling
)
RelationshipType constant values
func (RelationshipType) New
func (t RelationshipType) New() *RelationshipType
New returns a pointer to the type (used with constants for ease of use with optional values)
type SentBy
type SentBy string
SentBy is used to specify the calendar user that is acting on behalf of the calendar user specified by the property
func NewSentBy
func NewSentBy(v SentBy) *SentBy
NewSentBy returns a *SentBy for ease of use with optional values
type Standard
type Standard struct {
DateTimeStart PropDateTimeStart
TimezoneOffsetTo PropTimezoneOffsetTo
TimezoneOffsetFrom PropTimezoneOffsetFrom
RecurrenceRule *PropRecurrenceRule
Comment []PropComment
RecurrenceDateTimes []PropRecurrenceDateTimes
TimezoneName []PropTimezoneName
}
Standard represents standard timezone rules
type TFloat
type TFloat [2]float64
TFloat is a pair of float values used for coords
type Text
type Text string
Text contains human-readable text
type Time
type Time struct {
time.Time
}
Time contains a precise time
type Timezone
type Timezone struct {
TimezoneID PropTimezoneID
LastModified *PropLastModified
TimezoneURL *PropTimezoneURL
Standard []Standard
Daylight []Daylight
}
Timezone provide a group of components that defines a time zone
type TimezoneID
type TimezoneID string
TimezoneID is used to specify the identifier for the time zone definition for a time component in the property value
func NewTimezoneID
func NewTimezoneID(v TimezoneID) *TimezoneID
NewTimezoneID returns a *TimezoneID for ease of use with optional values
type Todo
type Todo struct {
DateTimeStamp PropDateTimeStamp
UID PropUID
Class *PropClass
Completed *PropCompleted
Created *PropCreated
Description *PropDescription
DateTimeStart *PropDateTimeStart
Geo *PropGeo
LastModified *PropLastModified
Location *PropLocation
Organizer *PropOrganizer
PercentComplete *PropPercentComplete
Priority *PropPriority
RecurrenceID *PropRecurrenceID
Sequence *PropSequence
Status *PropStatus
Summary *PropSummary
URL *PropURL
Due *PropDue
Duration *PropDuration
Attachment []PropAttachment
Attendee []PropAttendee
Categories []PropCategories
Comment []PropComment
Contact []PropContact
ExceptionDateTime []PropExceptionDateTime
RequestStatus []PropRequestStatus
RelatedTo []PropRelatedTo
Resources []PropResources
RecurrenceDateTimes []PropRecurrenceDateTimes
Alarm []Alarm
}
Todo provides a group of components that describe a to-do
type URI
type URI struct {
url.URL
}
URI contains a reference to another piece of data
type UTCOffset
type UTCOffset int
UTCOffset contains the offset from UTC to local time
type Value
type Value uint8
Value is used to explicitly specify the value type format for a property value
const (
ValueUnknown Value = iota
ValueBinary
ValueBoolean
ValueCalendarAddress
ValueDate
ValueDateTime
ValueDuration
ValueFloat
ValueInteger
ValuePeriod
ValueRecur
ValueText
ValueTime
ValueURI
ValueUTCOffset
)
Value constant values
func (Value) New
func (t Value) New() *Value
New returns a pointer to the type (used with constants for ease of use with optional values)
type WeekDay
type WeekDay uint8
WeekDay is a numeric representation of a Day of the Week
const (
UnknownDay WeekDay = iota
Sunday
Monday
Tuesday
Wednesday
Thursday
Friday
Saturday
)
Weekday constant values
Documentation
¶
Overview ¶
Package ics implements an encoder and decoder for iCalendar files
Index ¶
- Variables
- func Encode(w io.Writer, cal *Calendar) error
- type Alarm
- type AlarmAudio
- type AlarmDisplay
- type AlarmEmail
- type AlarmType
- type AlternativeRepresentation
- type Binary
- type Boolean
- type Calendar
- type CalendarAddress
- type CalendarUserType
- type CommonName
- type Date
- type DateTime
- type DayRecur
- type Daylight
- type Delagatee
- type Delegator
- type DirectoryEntry
- type Duration
- type Encoding
- type Event
- type Float
- type FormatType
- type FreeBusy
- type FreeBusyType
- type Frequency
- type Integer
- type Journal
- type Language
- type MText
- type Member
- type Month
- type ParticipationRole
- type ParticipationStatus
- type Period
- type PropAction
- type PropAttachment
- type PropAttendee
- type PropCalendarScale
- type PropCategories
- type PropClass
- type PropComment
- type PropCompleted
- type PropContact
- type PropCreated
- type PropDateTimeEnd
- type PropDateTimeStamp
- type PropDateTimeStart
- type PropDescription
- type PropDue
- type PropDuration
- type PropExceptionDateTime
- type PropFreeBusy
- type PropGeo
- type PropLastModified
- type PropLocation
- type PropMethod
- type PropOrganizer
- type PropPercentComplete
- type PropPriority
- type PropProductID
- type PropRecurrenceDateTimes
- type PropRecurrenceID
- type PropRecurrenceRule
- type PropRelatedTo
- type PropRepeat
- type PropRequestStatus
- type PropResources
- type PropSequence
- type PropStatus
- type PropSummary
- type PropTimeTransparency
- type PropTimezoneID
- type PropTimezoneName
- type PropTimezoneOffsetFrom
- type PropTimezoneOffsetTo
- type PropTimezoneURL
- type PropTrigger
- type PropUID
- type PropURL
- type PropVersion
- type RSVP
- type Range
- type Recur
- type Related
- type RelationshipType
- type SentBy
- type Standard
- type TFloat
- type Text
- type Time
- type Timezone
- type TimezoneID
- type Todo
- type URI
- type UTCOffset
- type Value
- type WeekDay
Constants ¶
This section is empty.
Variables ¶
var ( ErrInvalidParam = errors.New("invalid param value") ErrInvalidValue = errors.New("invalid value") )
Errors
var ( ErrMultipleSingle = errors.New("unique property found multiple times") ErrInvalidEnd = errors.New("invalid end of section") ErrMissingRequired = errors.New("required property missing") ErrRequirementNotMet = errors.New("requirement not met") )
Errors
var ( ErrInvalidStructure = errors.New("invalid structure") ErrMissingAlarmAction = errors.New("missing alarm action") ErrInvalidAlarm = errors.New("invalid alarm type") )
Errors
var ( ErrInvalidContentLine = errors.New("invalid content line") ErrInvalidContentLineName = errors.New("invalid content line name") ErrInvalidContentLineParamName = errors.New("invalid content line param name") ErrInvalidContentLineQuotedParamValue = errors.New("invalid content line quoted param value") ErrInvalidContentLineParamValue = errors.New("invalid content line param value") ErrInvalidContentLineValue = errors.New("invalid content line value") )
Errors
var ( ErrInvalidEncoding = errors.New("invalid Binary encoding") ErrInvalidPeriod = errors.New("invalid Period") ErrInvalidDuration = errors.New("invalid Duration") ErrInvalidText = errors.New("invalid encoded text") ErrInvalidBoolean = errors.New("invalid Boolean") ErrInvalidOffset = errors.New("invalid UTC Offset") ErrInvalidRecur = errors.New("invalid Recur") ErrInvalidTime = errors.New("invalid time") ErrInvalidFloat = errors.New("invalid float") ErrInvalidTFloat = errors.New("invalid number of floats") ErrInvalidPeriodStart = errors.New("invalid start of Period") ErrInvalidPeriodDuration = errors.New("invalid Period duration") ErrInvalidPeriodEnd = errors.New("invalid end of Period") ErrInvalidRecurFrequency = errors.New("invalid Recur frequency") ErrInvalidRecurBySecond = errors.New("invalid Recur BySecond") ErrInvalidRecurByMinute = errors.New("invalid Recur ByMinute") ErrInvalidRecurByHour = errors.New("invalid Recur ByHour") ErrInvalidRecurByDay = errors.New("invalid Recur ByDay") ErrInvalidRecurByMonthDay = errors.New("invalid Recur ByMonthDay") ErrInvalidRecurByYearDay = errors.New("invalid Recur ByYearDay") ErrInvalidRecurByWeekNum = errors.New("invalid Recur ByWeekNum") ErrInvalidRecurByMonth = errors.New("invalid Recur ByMonth") ErrInvalidRecurBySetPos = errors.New("invalid Recur BySetPos") ErrInvalidRecurWeekStart = errors.New("invalid Recur WeekStart") )
Errors
var CommonLocaleDataRepositoryTranslator = map[string]string{}/* 395 elements not displayed */
CommonLocaleDataRepositoryTranslator maps between the CLDR timezone to the first IANA territory in said zone. See http://unicode.org/repos/cldr/trunk/common/supplemental/windowsZones.xml;
var (
ErrDuplicateParam = errors.New("duplicate param")
)
Errors
var (
ErrInvalidCalendar = errors.New("invalid calendar")
)
Errors
var UtcOffsetToTimezoneMap = map[string]string{
"-1200": "Etc/GMT+12",
"-1100": "Etc/GMT+11",
"-1000": "America/Adak",
"-0930": "Pacific/Marquesas",
"-0900": "America/Anchorage",
"-0800": "America/Los_Angeles",
"-0700": "America/Phoenix",
"-0600": "America/Guatemala",
"-0500": "America/New_York",
"-0400": "America/Santiago",
"-0330": "America/St_Johns",
"-0300": "America/Buenos_Aires",
"-0200": "Etc/GMT+2",
"-0100": "Atlantic/Cape_Verde",
"+0000": "Europe/London",
"0000": "Europe/London",
"+0100": "Europe/Berlin",
"+0200": "Africa/Cairo",
"+0300": "Europe/Moscow",
"+0400": "Asia/Dubai",
"+0430": "Asia/Kabul",
"+0500": "Asia/Karachi",
"+0530": "Asia/Calcutta",
"+0545": "Asia/Katmandu",
"+0600": "Asia/Dhaka",
"+0630": "Asia/Rangoon",
"+0700": "Asia/Bangkok",
"+0800": "Asia/Shanghai",
"+0830": "Asia/Pyongyang",
"+0845": "Australia/Eucla",
"+0900": "Asia/Tokyo",
"+0930": "Australia/Darwin",
"+1000": "Australia/Sydney",
"+1030": "Australia/Lord_Howe",
"+1100": "Pacific/Norfolk",
"+1200": "Pacific/Fiji",
"+1245": "Pacific/Chatham",
"+1300": "Pacific/Tongatapu",
"+1400": "Pacific/Kiritimati",
}
UtcOffsetToTimezoneMap translates the UTC time offset to one of the timezones that can ber parsed by ICS parsers.
Functions ¶
Types ¶
type Alarm ¶
type Alarm struct {
AlarmType
}
Alarm is the encompassing type for the three alarm types
type AlarmAudio ¶
type AlarmAudio struct {
Trigger PropTrigger
Duration *PropDuration
Repeat *PropRepeat
Attachment []PropAttachment
}
AlarmAudio provides a group of components that define an Audio Alarm
type AlarmDisplay ¶
type AlarmDisplay struct {
Description PropDescription
Trigger PropTrigger
Duration *PropDuration
Repeat *PropRepeat
}
AlarmDisplay provides a group of components that define a Display Alarm
func (AlarmDisplay) Type ¶
func (AlarmDisplay) Type() string
Type returns the type of the alarm "DISPLAY"
type AlarmEmail ¶
type AlarmEmail struct {
Description PropDescription
Trigger PropTrigger
Summary PropSummary
Attendee *PropAttendee
Duration *PropDuration
Repeat *PropRepeat
}
AlarmEmail provides a group of components that define an Email Alarm
type AlarmType ¶
type AlarmType interface {
Type() string
// contains filtered or unexported methods
}
AlarmType is an interface this is fulfilled by AlarmAudio, AlarmDisplay and AlarmEmail
type AlternativeRepresentation ¶
type AlternativeRepresentation URI
AlternativeRepresentation is an alternate text representation for the property value
type Calendar ¶
type Calendar struct {
Version PropVersion
ProductID PropProductID
Event []Event
Todo []Todo
Journal []Journal
FreeBusy []FreeBusy
Timezone []Timezone
}
Calendar represents a iCalendar object
type CalendarAddress ¶
CalendarAddress contains a calendar user address
type CalendarUserType ¶
type CalendarUserType uint8
CalendarUserType is identify the type of calendar user specified by the property
const ( CalendarUserTypeUnknown CalendarUserType = iota CalendarUserTypeIndividual CalendarUserTypeGroup CalendarUserTypeResource CalendarUserTypeRoom )
CalendarUserType constant values
func (CalendarUserType) New ¶
func (t CalendarUserType) New() *CalendarUserType
New returns a pointer to the type (used with constants for ease of use with optional values)
type CommonName ¶
type CommonName string
CommonName is the common name to be associated with the calendar user specified by the property
func NewCommonName ¶
func NewCommonName(v CommonName) *CommonName
NewCommonName returns a *CommonName for ease of use with optional values
type DayRecur ¶
DayRecur is used to reprent the nth day in a time period, be it 2nd Monday in a Month, or 31st Friday in a year, etc.
type Daylight ¶
type Daylight struct {
DateTimeStart PropDateTimeStart
TimezoneOffsetTo PropTimezoneOffsetTo
TimezoneOffsetFrom PropTimezoneOffsetFrom
RecurrenceRule *PropRecurrenceRule
Comment []PropComment
RecurrenceDateTimes []PropRecurrenceDateTimes
TimezoneName []PropTimezoneName
}
Daylight represents daylight savings timezone rules
type Delagatee ¶
type Delagatee []CalendarAddress
Delagatee is used to specify the calendar users to whom the calendar user specified by the property has delegated participation
type Delegator ¶
type Delegator []CalendarAddress
Delegator is used to specify the calendar users that have delegated their participation to the calendar user specified by the property
type DirectoryEntry ¶
type DirectoryEntry string
DirectoryEntry is a reference to a directory entry associated with the calendar
func NewDirectoryEntry ¶
func NewDirectoryEntry(v DirectoryEntry) *DirectoryEntry
NewDirectoryEntry returns a *DirectoryEntry for ease of use with optional values
type Event ¶
type Event struct {
DateTimeStamp PropDateTimeStamp
UID PropUID
DateTimeStart *PropDateTimeStart
Class *PropClass
Created *PropCreated
Description *PropDescription
Geo *PropGeo
LastModified *PropLastModified
Location *PropLocation
Organizer *PropOrganizer
XOrganizer *PropOrganizer
Priority *PropPriority
Sequence *PropSequence
Status *PropStatus
Summary *PropSummary
TimeTransparency *PropTimeTransparency
URL *PropURL
RecurrenceID *PropRecurrenceID
RecurrenceRule *PropRecurrenceRule
DateTimeEnd *PropDateTimeEnd
Duration *PropDuration
Attachment []PropAttachment
Attendee []PropAttendee
Categories []PropCategories
Comment []PropComment
Contact []PropContact
ExceptionDateTime []PropExceptionDateTime
RequestStatus []PropRequestStatus
RelatedTo []PropRelatedTo
Resources []PropResources
RecurrenceDateTimes []PropRecurrenceDateTimes
Alarm []Alarm
}
Event provides a group of components that describe an event
type FormatType ¶
type FormatType string
FormatType is the content type of a referenced object
func NewFormatType ¶
func NewFormatType(v FormatType) *FormatType
NewFormatType returns a *FormatType for ease of use with optional values
type FreeBusy ¶
type FreeBusy struct {
DateTimeStamp PropDateTimeStamp
UID PropUID
Contact *PropContact
DateTimeStart *PropDateTimeStart
DateTimeEnd *PropDateTimeEnd
Organizer *PropOrganizer
URL *PropURL
Attendee []PropAttendee
Comment []PropComment
FreeBusy []PropFreeBusy
RequestStatus []PropRequestStatus
}
FreeBusy provides a group of components that describe either a request for free/busy time, describe a response to a request for free/busy time, or describe a published set of busy time
type FreeBusyType ¶
type FreeBusyType uint8
FreeBusyType is used to specify the free or busy time type
const ( FreeBusyTypeUnknown FreeBusyType = iota FreeBusyTypeFree FreeBusyTypeBusy FreeBusyTypeBusyTentative )
FreeBusyType constant values
func (FreeBusyType) New ¶
func (t FreeBusyType) New() *FreeBusyType
New returns a pointer to the type (used with constants for ease of use with optional values)
type Journal ¶
type Journal struct {
DateTimeStamp PropDateTimeStamp
UID PropUID
Class *PropClass
Created *PropCreated
DateTimeStart *PropDateTimeStart
LastModified *PropLastModified
Organizer *PropOrganizer
RecurrenceID *PropRecurrenceID
Sequence *PropSequence
Status *PropStatus
Summary *PropSummary
URL *PropURL
RecurrenceRule *PropRecurrenceRule
Attachment []PropAttachment
Attendee []PropAttendee
Categories []PropCategories
Comment []PropComment
Contact []PropContact
Description []PropDescription
ExceptionDateTime []PropExceptionDateTime
RequestStatus []PropRequestStatus
RelatedTo []PropRelatedTo
Resources []PropResources
RecurrenceDateTimes []PropRecurrenceDateTimes
}
Journal provides a group of components that describe a journal entry
type Language ¶
type Language string
Language is the language for text values
func NewLanguage ¶
NewLanguage returns a *Language for ease of use with optional values
type Member ¶
type Member []string
Member is used to specify the group or list membership of the calendar
type ParticipationRole ¶
type ParticipationRole uint8
ParticipationRole is used to specify the participation role for the calendar user specified by the property
const ( ParticipationRoleUnknown ParticipationRole = iota ParticipationRoleRequiredParticipant ParticipationRoleChair ParticipationRoleOptParticipant ParticipationRoleNonParticipant )
ParticipationRole constant values
func (ParticipationRole) New ¶
func (t ParticipationRole) New() *ParticipationRole
New returns a pointer to the type (used with constants for ease of use with optional values)
type ParticipationStatus ¶
type ParticipationStatus uint8
ParticipationStatus is used to specify the participation status for the calendar
const ( ParticipationStatusUnknown ParticipationStatus = iota ParticipationStatusNeedsAction ParticipationStatusAccepted ParticipationStatusDeclined ParticipationStatusTentative ParticipationStatusDelegated ParticipationStatusCompleted ParticipationStatusInProcess )
ParticipationStatus constant values
func (ParticipationStatus) New ¶
func (t ParticipationStatus) New() *ParticipationStatus
New returns a pointer to the type (used with constants for ease of use with optional values)
type Period ¶
Period represents a precise period of time/
Only one of End or Duration will be used. If Period.End.IsZero() is true, then it uses Period.Duration
type PropAction ¶
type PropAction uint8
PropAction defines the action to be invoked when an alarm is triggered
const ( ActionAudio PropAction = iota ActionDisplay ActionEmail )
PropAction constant values
func (PropAction) New ¶
func (p PropAction) New() *PropAction
New returns a pointer to the type (used with constants for ease of use with optional values)
type PropAttachment ¶
type PropAttachment struct {
FormatType *FormatType
URI *URI
Binary *Binary
}
PropAttachment provides the capability to associate a document object with a calendar component
type PropAttendee ¶
type PropAttendee struct {
CalendarUserType *CalendarUserType
Member Member
ParticipationRole *ParticipationRole
ParticipationStatus *ParticipationStatus
RSVP *RSVP
Delagatee Delagatee
Delegator Delegator
SentBy *SentBy
CommonName *CommonName
DirectoryEntry *DirectoryEntry
Language *Language
CalendarAddress
}
PropAttendee defines an "Attendee" within a calendar component
type PropCalendarScale ¶
type PropCalendarScale uint8
PropCalendarScale defines the calendar scale
const (
CalendarScaleGregorian PropCalendarScale = iota
)
PropCalendarScale constant values
func (PropCalendarScale) New ¶
func (p PropCalendarScale) New() *PropCalendarScale
New returns a pointer to the type (used with constants for ease of use with optional values)
type PropCategories ¶
PropCategories defines the categories for a calendar component
type PropClass ¶
type PropClass uint8
PropClass defines the access classification for a calendar component
type PropComment ¶
type PropComment struct {
AlternativeRepresentation *AlternativeRepresentation
Language *Language
Text
}
PropComment specifies non-processing information intended to provide a comment to the calendar user
type PropCompleted ¶
type PropCompleted DateTime
PropCompleted defines the date and time that a to-do was actually completed
type PropContact ¶
type PropContact struct {
AlternativeRepresentation *AlternativeRepresentation
Language *Language
Text
}
PropContact is used to represent contact information or alternately a reference to contact information associated with the calendar component
type PropCreated ¶
type PropCreated DateTime
PropCreated specifies the date and time that the calendar information was created by the calendar user agent in the calendar store
type PropDateTimeEnd ¶
PropDateTimeEnd specifies the date and time that a calendar component ends
type PropDateTimeStamp ¶
type PropDateTimeStamp DateTime
PropDateTimeStamp specifies the date and time that the calendar object was created unless the calendar object has no METHOD property, in which case it specifies the date and time that the information with the calendar was last revised
type PropDateTimeStart ¶
PropDateTimeStart specifies when the calendar component begins
type PropDescription ¶
type PropDescription struct {
AlternativeRepresentation *AlternativeRepresentation
Language *Language
Text
}
PropDescription provides a more complete description of the calendar component than that provided by the "SUMMARY" property
type PropExceptionDateTime ¶
PropExceptionDateTime defines the list of DATE-TIME exceptions for recurring events, to-dos, journal entries, or time zone definitions
type PropFreeBusy ¶
type PropFreeBusy struct {
FreeBusyType *FreeBusyType
Period
}
PropFreeBusy defines one or more free or busy time intervals
type PropGeo ¶
type PropGeo TFloat
PropGeo specifies information related to the global position for the activity specified by a calendar component
type PropLastModified ¶
type PropLastModified DateTime
PropLastModified specifies the date and time that the information associated with the calendar component was last revised in the calendar store
type PropLocation ¶
type PropLocation struct {
AlternativeRepresentation *AlternativeRepresentation
Language *Language
Text
}
PropLocation defines the intended venue for the activity defined by a calendar component
type PropMethod ¶
type PropMethod Text
PropMethod defines the iCalendar object method associated with the calendar object
type PropOrganizer ¶
type PropOrganizer struct {
CommonName *CommonName
DirectoryEntry *DirectoryEntry
SentBy *SentBy
Language *Language
CalendarAddress
}
PropOrganizer defines the organizer for a calendar component
type PropPercentComplete ¶
type PropPercentComplete Integer
PropPercentComplete is used by an assignee or delegatee of a to-do to convey the percent completion of a to-do to the "Organizer"
func NewPercentComplete ¶
func NewPercentComplete(v PropPercentComplete) *PropPercentComplete
NewPercentComplete generates a pointer to a constant value. Used when manually creating Calendar values
type PropPriority ¶
type PropPriority Integer
PropPriority defines the relative priority for a calendar component
func NewPriority ¶
func NewPriority(v PropPriority) *PropPriority
NewPriority generates a pointer to a constant value. Used when manually creating Calendar values
type PropProductID ¶
type PropProductID Text
PropProductID specifies the identifier for the product that created the iCalendar object
type PropRecurrenceDateTimes ¶
PropRecurrenceDateTimes defines the list of DATE-TIME values for recurring events, to-dos, journal entries, or time zone definitions
type PropRecurrenceID ¶
PropRecurrenceID is used to identify a specific instance of a recurring Event, Todo or Journal
type PropRecurrenceRule ¶
type PropRecurrenceRule Recur
PropRecurrenceRule defines a rule or repeating pattern for recurring events, to-dos, journal entries, or time zone definitions
type PropRelatedTo ¶
type PropRelatedTo struct {
RelationshipType *RelationshipType
Text
}
PropRelatedTo is used to represent a relationship or reference between one calendar component and another
type PropRepeat ¶
type PropRepeat Integer
PropRepeat defines the number of times the alarm should be repeated, after the initial trigger
func NewRepeat ¶
func NewRepeat(v PropRepeat) *PropRepeat
NewRepeat generates a pointer to a constant value. Used when manually creating Calendar values
type PropRequestStatus ¶
type PropRequestStatus Text
PropRequestStatus defines the status code returned for a scheduling request
type PropResources ¶
type PropResources struct {
AlternativeRepresentation *AlternativeRepresentation
Language *Language
MText
}
PropResources defines the equipment or resources anticipated for an activity specified by a calendar component
type PropSequence ¶
type PropSequence Integer
PropSequence defines the revision sequence number of the calendar component within a sequence of revisions
func NewSequence ¶
func NewSequence(v PropSequence) *PropSequence
NewSequence generates a pointer to a constant value. Used when manually creating Calendar values
type PropStatus ¶
type PropStatus uint8
PropStatus defines the overall status or confirmation for the calendar component
const ( StatusTentative PropStatus = iota StatusConfirmed StatusCancelled StatusNeedsAction StatusCompleted StatusInProcess StatusDraft StatusFinal )
PropStatus constant values
func (PropStatus) New ¶
func (p PropStatus) New() *PropStatus
New returns a pointer to the type (used with constants for ease of use with optional values)
type PropSummary ¶
type PropSummary struct {
AlternativeRepresentation *AlternativeRepresentation
Language *Language
Text
}
PropSummary defines a short summary or subject for the calendar component
type PropTimeTransparency ¶
type PropTimeTransparency uint8
PropTimeTransparency defines whether or not an event is transparent to busy time searches
const ( TimeTransparencyOpaque PropTimeTransparency = iota TimeTransparencyTransparent )
PropTimeTransparency constant values
func (PropTimeTransparency) New ¶
func (p PropTimeTransparency) New() *PropTimeTransparency
New returns a pointer to the type (used with constants for ease of use with optional values)
type PropTimezoneID ¶
type PropTimezoneID Text
PropTimezoneID specifies the text value that uniquely identifies the "VTIMEZONE" calendar component in the scope of an iCalendar object
type PropTimezoneName ¶
PropTimezoneName specifies the customary designation for a time zone description
type PropTimezoneOffsetFrom ¶
type PropTimezoneOffsetFrom UTCOffset
PropTimezoneOffsetFrom specifies the offset that is in use prior to this time zone observance
type PropTimezoneOffsetTo ¶
type PropTimezoneOffsetTo UTCOffset
PropTimezoneOffsetTo specifies the offset that is in use in this time zone observance
type PropTimezoneURL ¶
type PropTimezoneURL URI
PropTimezoneURL provides a means for a "VTIMEZONE" component to point to a network location that can be used to retrieve an up- to-date version of itself
type PropTrigger ¶
PropTrigger specifies when an alarm will trigger
type PropUID ¶
type PropUID Text
PropUID defines the persistent, globally unique identifier for the calendar component
type PropURL ¶
type PropURL URI
PropURL defines a Uniform Resource Locator associated with the iCalendar object
type PropVersion ¶
type PropVersion Text
PropVersion specifies the identifier corresponding to the highest version number or the minimum and maximum range of the iCalendar specification that is required in order to interpret the iCalendar object
type RSVP ¶
type RSVP Boolean
RSVP is used to specify whether there is an expectation of a favor of a reply from the calendar user specified by the property value
type Range ¶
type Range struct{}
Range is used to specify the effective range of recurrence instances from the instance specified by the recurrence identifier specified by the property
type Recur ¶
type Recur struct {
Frequency Frequency
Until time.Time
UntilTime bool
Count uint64
Interval uint64
BySecond []uint8
ByMinute []uint8
ByHour []uint8
ByDay []DayRecur
ByMonthDay []int8
ByYearDay []int16
ByWeekNum []int8
ByMonth []Month
BySetPos []int16
WeekStart WeekDay
}
Recur contains a recurrence rule specification
type Related ¶
type Related uint8
Related is the relationship of the alarm trigger with respect to the start or end of the calendar component
type RelationshipType ¶
type RelationshipType uint8
RelationshipType is the type of hierarchical relationship associated with the calendar component specified by the property
const ( RelationshipTypeUnknown RelationshipType = iota RelationshipTypeParent RelationshipTypeChild RelationshipTypeSibling )
RelationshipType constant values
func (RelationshipType) New ¶
func (t RelationshipType) New() *RelationshipType
New returns a pointer to the type (used with constants for ease of use with optional values)
type SentBy ¶
type SentBy string
SentBy is used to specify the calendar user that is acting on behalf of the calendar user specified by the property
type Standard ¶
type Standard struct {
DateTimeStart PropDateTimeStart
TimezoneOffsetTo PropTimezoneOffsetTo
TimezoneOffsetFrom PropTimezoneOffsetFrom
RecurrenceRule *PropRecurrenceRule
Comment []PropComment
RecurrenceDateTimes []PropRecurrenceDateTimes
TimezoneName []PropTimezoneName
}
Standard represents standard timezone rules
type Timezone ¶
type Timezone struct {
TimezoneID PropTimezoneID
LastModified *PropLastModified
TimezoneURL *PropTimezoneURL
Standard []Standard
Daylight []Daylight
}
Timezone provide a group of components that defines a time zone
type TimezoneID ¶
type TimezoneID string
TimezoneID is used to specify the identifier for the time zone definition for a time component in the property value
func NewTimezoneID ¶
func NewTimezoneID(v TimezoneID) *TimezoneID
NewTimezoneID returns a *TimezoneID for ease of use with optional values
type Todo ¶
type Todo struct {
DateTimeStamp PropDateTimeStamp
UID PropUID
Class *PropClass
Completed *PropCompleted
Created *PropCreated
Description *PropDescription
DateTimeStart *PropDateTimeStart
Geo *PropGeo
LastModified *PropLastModified
Location *PropLocation
Organizer *PropOrganizer
PercentComplete *PropPercentComplete
Priority *PropPriority
RecurrenceID *PropRecurrenceID
Sequence *PropSequence
Status *PropStatus
Summary *PropSummary
URL *PropURL
Due *PropDue
Duration *PropDuration
Attachment []PropAttachment
Attendee []PropAttendee
Categories []PropCategories
Comment []PropComment
Contact []PropContact
ExceptionDateTime []PropExceptionDateTime
RequestStatus []PropRequestStatus
RelatedTo []PropRelatedTo
Resources []PropResources
RecurrenceDateTimes []PropRecurrenceDateTimes
Alarm []Alarm
}
Todo provides a group of components that describe a to-do
type Value ¶
type Value uint8
Value is used to explicitly specify the value type format for a property value
Source Files