Calendar


Data Structures
struct	GSM_CalendarSettings
struct	GSM_CalendarStatus
struct	GSM_SubCalendarEntry
struct	GSM_CalendarEntry
struct	GSM_Alarm
Enumerations
enum	GSM_CalendarNoteType { GSM_CAL_REMINDER = 1, GSM_CAL_CALL, GSM_CAL_MEETING, GSM_CAL_BIRTHDAY, GSM_CAL_MEMO, GSM_CAL_TRAVEL, GSM_CAL_VACATION, GSM_CAL_T_ATHL, GSM_CAL_T_BALL, GSM_CAL_T_CYCL, GSM_CAL_T_BUDO, GSM_CAL_T_DANC, GSM_CAL_T_EXTR, GSM_CAL_T_FOOT, GSM_CAL_T_GOLF, GSM_CAL_T_GYM, GSM_CAL_T_HORS, GSM_CAL_T_HOCK, GSM_CAL_T_RACE, GSM_CAL_T_RUGB, GSM_CAL_T_SAIL, GSM_CAL_T_STRE, GSM_CAL_T_SWIM, GSM_CAL_T_TENN, GSM_CAL_T_TRAV, GSM_CAL_T_WINT, GSM_CAL_ALARM, GSM_CAL_DAILY_ALARM }
enum	GSM_CalendarType { CAL_START_DATETIME = 1, CAL_END_DATETIME, CAL_TONE_ALARM_DATETIME, CAL_SILENT_ALARM_DATETIME, CAL_TEXT, CAL_DESCRIPTION, CAL_LOCATION, CAL_PHONE, CAL_PRIVATE, CAL_CONTACTID, CAL_REPEAT_DAYOFWEEK, CAL_REPEAT_DAY, CAL_REPEAT_DAYOFYEAR, CAL_REPEAT_WEEKOFMONTH, CAL_REPEAT_MONTH, CAL_REPEAT_FREQUENCY, CAL_REPEAT_STARTDATE, CAL_REPEAT_STOPDATE, CAL_REPEAT_COUNT, CAL_LUID, CAL_LAST_MODIFIED }
enum	GSM_VCalendarVersion { Nokia_VCalendar = 1, Siemens_VCalendar, SonyEricsson_VCalendar, Mozilla_iCalendar }
Functions
void	GSM_CalendarFindDefaultTextTimeAlarmPhone (GSM_CalendarEntry entry, int Text, int Time, int Alarm, int Phone, int EndTime, int *Location)
GSM_Error	GSM_EncodeVCALENDAR (char Buffer, const size_t buff_len, size_t Length, GSM_CalendarEntry *note, const bool header, const GSM_VCalendarVersion Version)
GSM_Error	GSM_DecodeVCALENDAR_VTODO (GSM_Debug_Info di, char Buffer, size_t Pos, GSM_CalendarEntry Calendar, GSM_ToDoEntry *ToDo, GSM_VCalendarVersion CalVer, GSM_VToDoVersion ToDoVer)
bool	GSM_IsCalendarNoteFromThePast (GSM_CalendarEntry *note)
GSM_Error	GSM_GetAlarm (GSM_StateMachine s, GSM_Alarm Alarm)
GSM_Error	GSM_SetAlarm (GSM_StateMachine s, GSM_Alarm Alarm)
GSM_Error	GSM_GetCalendarStatus (GSM_StateMachine s, GSM_CalendarStatus Status)
GSM_Error	GSM_GetCalendar (GSM_StateMachine s, GSM_CalendarEntry Note)
GSM_Error	GSM_GetNextCalendar (GSM_StateMachine s, GSM_CalendarEntry Note, bool start)
GSM_Error	GSM_SetCalendar (GSM_StateMachine s, GSM_CalendarEntry Note)
GSM_Error	GSM_AddCalendar (GSM_StateMachine s, GSM_CalendarEntry Note)
GSM_Error	GSM_DeleteCalendar (GSM_StateMachine s, GSM_CalendarEntry Note)
GSM_Error	GSM_DeleteAllCalendar (GSM_StateMachine *s)
GSM_Error	GSM_GetCalendarSettings (GSM_StateMachine s, GSM_CalendarSettings settings)
GSM_Error	GSM_SetCalendarSettings (GSM_StateMachine s, GSM_CalendarSettings settings)

Detailed Description

Calendar events manipulations.

Enumeration Type Documentation

enum GSM_CalendarNoteType

Enum defines types of calendar notes

Enumerator:

GSM_CAL_REMINDER	Reminder or Date
GSM_CAL_CALL	Call
GSM_CAL_MEETING	Meeting
GSM_CAL_BIRTHDAY	Birthday or Anniversary or Special Occasion
GSM_CAL_MEMO	Memo or Miscellaneous
GSM_CAL_TRAVEL	Travel
GSM_CAL_VACATION	Vacation
GSM_CAL_T_ATHL	Training - Athletism
GSM_CAL_T_BALL	Training - Ball Games
GSM_CAL_T_CYCL	Training - Cycling
GSM_CAL_T_BUDO	Training - Budo
GSM_CAL_T_DANC	Training - Dance
GSM_CAL_T_EXTR	Training - Extreme Sports
GSM_CAL_T_FOOT	Training - Football
GSM_CAL_T_GOLF	Training - Golf
GSM_CAL_T_GYM	Training - Gym
GSM_CAL_T_HORS	Training - Horse Race
GSM_CAL_T_HOCK	Training - Hockey
GSM_CAL_T_RACE	Training - Races
GSM_CAL_T_RUGB	Training - Rugby
GSM_CAL_T_SAIL	Training - Sailing
GSM_CAL_T_STRE	Training - Street Games
GSM_CAL_T_SWIM	Training - Swimming
GSM_CAL_T_TENN	Training - Tennis
GSM_CAL_T_TRAV	Training - Travels
GSM_CAL_T_WINT	Training - Winter Games
GSM_CAL_ALARM	Alarm
GSM_CAL_DAILY_ALARM	Alarm repeating each day.

Definition at line 82 of file gammu-calendar.h.

00082              {
00086         GSM_CAL_REMINDER = 1,
00090         GSM_CAL_CALL,
00094         GSM_CAL_MEETING,
00098         GSM_CAL_BIRTHDAY,
00102         GSM_CAL_MEMO,
00106         GSM_CAL_TRAVEL,
00110         GSM_CAL_VACATION,
00114         GSM_CAL_T_ATHL,
00118         GSM_CAL_T_BALL,
00122         GSM_CAL_T_CYCL,
00126         GSM_CAL_T_BUDO,
00130         GSM_CAL_T_DANC,
00134         GSM_CAL_T_EXTR,
00138         GSM_CAL_T_FOOT,
00142         GSM_CAL_T_GOLF,
00146         GSM_CAL_T_GYM,
00150         GSM_CAL_T_HORS,
00154         GSM_CAL_T_HOCK,
00158         GSM_CAL_T_RACE,
00162         GSM_CAL_T_RUGB,
00166         GSM_CAL_T_SAIL,
00170         GSM_CAL_T_STRE,
00174         GSM_CAL_T_SWIM,
00178         GSM_CAL_T_TENN,
00182         GSM_CAL_T_TRAV,
00186         GSM_CAL_T_WINT,
00190         GSM_CAL_ALARM,
00194         GSM_CAL_DAILY_ALARM
00195 } GSM_CalendarNoteType;

enum GSM_CalendarType

One value of calendar event.

Enumerator:

CAL_START_DATETIME	Date and time of event start.
CAL_END_DATETIME	Date and time of event end.
CAL_TONE_ALARM_DATETIME	Alarm date and time.
CAL_SILENT_ALARM_DATETIME	Date and time of silent alarm.
CAL_TEXT	Text.
CAL_DESCRIPTION	Detailed description.
CAL_LOCATION	Location.
CAL_PHONE	Phone number.
CAL_PRIVATE	Whether this entry is private.
CAL_CONTACTID	Related contact id.
CAL_REPEAT_DAYOFWEEK	Repeat each x'th day of week.
CAL_REPEAT_DAY	Repeat each x'th day of month.
CAL_REPEAT_DAYOFYEAR	Repeat each x'th day of year.
CAL_REPEAT_WEEKOFMONTH	Repeat x'th week of month.
CAL_REPEAT_MONTH	Repeat x'th month.
CAL_REPEAT_FREQUENCY	Repeating frequency.
CAL_REPEAT_STARTDATE	Repeating start.
CAL_REPEAT_STOPDATE	Repeating end.
CAL_REPEAT_COUNT	Number of repetitions.
CAL_LUID	IrMC LUID which can be used for synchronisation.
CAL_LAST_MODIFIED	Date and time of last modification.

Definition at line 202 of file gammu-calendar.h.

00202              {
00206         CAL_START_DATETIME = 1,
00210         CAL_END_DATETIME,
00214         CAL_TONE_ALARM_DATETIME,
00218         CAL_SILENT_ALARM_DATETIME,
00222         CAL_TEXT,
00226         CAL_DESCRIPTION,
00230         CAL_LOCATION,
00234         CAL_PHONE,
00238         CAL_PRIVATE,
00242         CAL_CONTACTID, /* 10 */
00246         CAL_REPEAT_DAYOFWEEK,
00250         CAL_REPEAT_DAY,
00254         CAL_REPEAT_DAYOFYEAR,
00258         CAL_REPEAT_WEEKOFMONTH,
00262         CAL_REPEAT_MONTH,
00266         CAL_REPEAT_FREQUENCY,
00270         CAL_REPEAT_STARTDATE,
00274         CAL_REPEAT_STOPDATE,
00278         CAL_REPEAT_COUNT,
00282         CAL_LUID, /* 20 */
00286         CAL_LAST_MODIFIED,
00287 } GSM_CalendarType;

enum GSM_VCalendarVersion

Format of vCalendar export.

Enumerator:

Nokia_VCalendar	vCalendar specially hacked for Nokia .
Siemens_VCalendar	vCalendar specially hacked for Siemens.
SonyEricsson_VCalendar	Standard vCalendar (which works for Sony-Ericsson phones)
Mozilla_iCalendar	iCalendar as compatible with Mozilla.

Definition at line 545 of file gammu-calendar.h.

00545              {
00549         Nokia_VCalendar = 1,
00553         Siemens_VCalendar,
00557         SonyEricsson_VCalendar,
00561         Mozilla_iCalendar,
00562 } GSM_VCalendarVersion;

Function Documentation

GSM_Error GSM_AddCalendar	(	GSM_StateMachine *	s,
		GSM_CalendarEntry *	Note
	)

Adds calendar entry.

Parameters:

	s	State machine pointer.
	Note	Note to add.

Returns:: Error code

void GSM_CalendarFindDefaultTextTimeAlarmPhone	(	GSM_CalendarEntry *	entry,
		int *	Text,
		int *	Time,
		int *	Alarm,
		int *	Phone,
		int *	EndTime,
		int *	Location
	)

Finds inxedes of default entries.

GSM_Error GSM_DecodeVCALENDAR_VTODO	(	GSM_Debug_Info *	di,
		char *	Buffer,
		size_t *	Pos,
		GSM_CalendarEntry *	Calendar,
		GSM_ToDoEntry *	ToDo,
		GSM_VCalendarVersion	CalVer,
		GSM_VToDoVersion	ToDoVer
	)

Decodes vCalendar and vTodo buffer.

Parameters:

	Buffer	Buffer to decode.
	Pos	Current position in buffer (will be updated).
	Calendar	Storage for calendar entry.
	ToDo	Storage for todo entry.
	CalVer	Format of vCalendar.
	ToDoVer	Format of vTodo.

Returns:: Error code

GSM_Error GSM_DeleteAllCalendar ( GSM_StateMachine * s )

Deletes all calendar entries.

Parameters:

s

State machine pointer.

Returns:: Error code

GSM_Error GSM_DeleteCalendar	(	GSM_StateMachine *	s,
		GSM_CalendarEntry *	Note
	)

Deletes calendar entry.

Parameters:

	s	State machine pointer.
	Note	Note to delete, must contain position.

Returns:: Error code

GSM_Error GSM_EncodeVCALENDAR	(	char *	Buffer,
		const size_t	buff_len,
		size_t *	Length,
		GSM_CalendarEntry *	note,
		const bool	header,
		const GSM_VCalendarVersion	Version
	)

Encodes vCalendar to buffer.

Parameters:

	Buffer	Storage for data.
`[in]`	buff_len	Size of output buffer.
	Length	Pointer to current position in data (will be incremented).
	note	Note to encode.
	header	Whether to include vCalendar header.
	Version	Format of vCalendar to create.

Returns:: Error code.

GSM_Error GSM_GetAlarm	(	GSM_StateMachine *	s,
		GSM_Alarm *	Alarm
	)

Reads alarm set in phone.

Parameters:

	s	State machine pointer.
	Alarm	Storage for alarm.

Returns:: Error code

GSM_Error GSM_GetCalendar	(	GSM_StateMachine *	s,
		GSM_CalendarEntry *	Note
	)

Retrieves calendar entry.

Parameters:

	s	State machine pointer.
	Note	Storage for note.

Returns:: Error code

GSM_Error GSM_GetCalendarSettings	(	GSM_StateMachine *	s,
		GSM_CalendarSettings *	settings
	)

Reads calendar settings.

Parameters:

	s	State machine pointer.
	settings	Storage for settings.

Returns:: Error code

GSM_Error GSM_GetCalendarStatus	(	GSM_StateMachine *	s,
		GSM_CalendarStatus *	Status
	)

Retrieves calendar status (number of used entries).

Parameters:

	s	State machine pointer.
	Status	Storage for status.

Returns:: Error code

GSM_Error GSM_GetNextCalendar	(	GSM_StateMachine *	s,
		GSM_CalendarEntry *	Note,
		bool	start
	)

Retrieves calendar entry. This is useful for continuous reading of all calendar entries.

Parameters:

	s	State machine pointer.
	Note	Storage for note, if start is false, should contain data from previous read (at least position).
	start	Whether we're doing initial read or continue in reading.

Returns:: Error code

bool GSM_IsCalendarNoteFromThePast ( GSM_CalendarEntry * note )

Detects whether calendar note is in past.

Parameters:

note

Note to check.

Returns:: Whether entry is in past.

GSM_Error GSM_SetAlarm	(	GSM_StateMachine *	s,
		GSM_Alarm *	Alarm
	)

Sets alarm in phone.

Parameters:

	s	State machine pointer.
	Alarm	Alarm to set.

Returns:: Error code

GSM_Error GSM_SetCalendar	(	GSM_StateMachine *	s,
		GSM_CalendarEntry *	Note
	)

Sets calendar entry

Parameters:

	s	State machine pointer.
	Note	New note values, needs to contain valid position.

Returns:: Error code

GSM_Error GSM_SetCalendarSettings	(	GSM_StateMachine *	s,
		GSM_CalendarSettings *	settings
	)

Sets calendar settings.

Parameters:

	s	State machine pointer.
	settings	New calendar settings.

Returns:: Error code

Calendar

Data Structures

Enumerations

Functions

Detailed Description

Enumeration Type Documentation

Function Documentation