Todo

Data Structures
struct	GSM_ToDoStatus
struct	GSM_SubToDoEntry
struct	GSM_ToDoEntry

Enumerations
enum	GSM_ToDoType {   TODO_END_DATETIME = 1, TODO_COMPLETED, TODO_ALARM_DATETIME, TODO_SILENT_ALARM_DATETIME,   TODO_TEXT, TODO_DESCRIPTION, TODO_LOCATION, TODO_PRIVATE,   TODO_CATEGORY, TODO_CONTACTID, TODO_PHONE, TODO_LUID,   TODO_LAST_MODIFIED, TODO_START_DATETIME, TODO_COMPLETED_DATETIME }
enum	GSM_ToDo_Priority {   GSM_Priority_None = 0, GSM_Priority_High, GSM_Priority_Medium, GSM_Priority_Low,   GSM_Priority_INVALID }
enum	GSM_VToDoVersion { Nokia_VToDo = 1, SonyEricsson_VToDo, Mozilla_VToDo }

Functions
GSM_Error	GSM_EncodeVTODO (char *Buffer, const size_t buff_len, size_t *Length, const GSM_ToDoEntry *note, const gboolean header, const GSM_VToDoVersion Version)
GSM_Error	GSM_GetToDoStatus (GSM_StateMachine *s, GSM_ToDoStatus *status)
GSM_Error	GSM_GetToDo (GSM_StateMachine *s, GSM_ToDoEntry *ToDo)
GSM_Error	GSM_GetNextToDo (GSM_StateMachine *s, GSM_ToDoEntry *ToDo, gboolean start)
GSM_Error	GSM_SetToDo (GSM_StateMachine *s, GSM_ToDoEntry *ToDo)
GSM_Error	GSM_AddToDo (GSM_StateMachine *s, GSM_ToDoEntry *ToDo)
GSM_Error	GSM_DeleteToDo (GSM_StateMachine *s, GSM_ToDoEntry *ToDo)
GSM_Error	GSM_DeleteAllToDo (GSM_StateMachine *s)

Detailed Description

Todo entries manipulations.

Enumeration Type Documentation

GSM_ToDo_Priority

enum GSM_ToDo_Priority

Priority of to do.

Enumerator
GSM_Priority_None
GSM_Priority_High
GSM_Priority_Medium
GSM_Priority_Low
GSM_Priority_INVALID

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

             {
        GSM_Priority_None = 0,
        GSM_Priority_High,
        GSM_Priority_Medium,
        GSM_Priority_Low,
        GSM_Priority_INVALID
} GSM_ToDo_Priority;

GSM_ToDoType

enum GSM_ToDoType

Types of to do values. In parenthesis is member of GSM_SubToDoEntry, where value is stored.

Enumerator
TODO_END_DATETIME	Due date (Date).
TODO_COMPLETED	Whether is completed (Number).
TODO_ALARM_DATETIME	When should alarm be fired (Date).
TODO_SILENT_ALARM_DATETIME	When should silent alarm be fired (Date).
TODO_TEXT	Text of to do (Text).
TODO_DESCRIPTION	Description of to do (Text).
TODO_LOCATION	Location of to do (Text).
TODO_PRIVATE	Whether entry is private (Number).
TODO_CATEGORY	Category of entry (Number).
TODO_CONTACTID	Related contact ID (Number).
TODO_PHONE	Number to call (Text).
TODO_LUID	IrMC LUID which can be used for synchronisation (Text).
TODO_LAST_MODIFIED	Date and time of last modification (Date).
TODO_START_DATETIME	Start date (Date).
TODO_COMPLETED_DATETIME	Completed date (Date).

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

             {
        TODO_END_DATETIME = 1,
        TODO_COMPLETED,
        TODO_ALARM_DATETIME,
        TODO_SILENT_ALARM_DATETIME,
        TODO_TEXT,
        TODO_DESCRIPTION,
        TODO_LOCATION,
        TODO_PRIVATE,
        TODO_CATEGORY,
        TODO_CONTACTID,
        TODO_PHONE,
        TODO_LUID,
        TODO_LAST_MODIFIED,
        TODO_START_DATETIME,
        TODO_COMPLETED_DATETIME,
} GSM_ToDoType;

GSM_VToDoVersion

enum GSM_VToDoVersion

Format of vTodo.

Enumerator
Nokia_VToDo	Format compatible with Nokia - limited subsed of standard.
SonyEricsson_VToDo	Format compatible with SonyEricsson - complete standard.
Mozilla_VToDo	Format compatible with Mozilla - iCalendar based.

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

             {
        Nokia_VToDo = 1,
        SonyEricsson_VToDo,
        Mozilla_VToDo,
} GSM_VToDoVersion;

Function Documentation

GSM_AddToDo()

GSM_Error GSM_AddToDo	(	GSM_StateMachine *	s,
		GSM_ToDoEntry *	ToDo
	)

Adds ToDo in phone.

Parameters

s	State machine pointer.
ToDo	ToDo to add.

Returns

Error code

Adds ToDo in phone.

Definition at line 1370 of file api.c.

References GSM_Phone_Functions::AddToDo, CHECK_PHONE_CONNECTION, GSM_Phone::Functions, _GSM_StateMachine::Phone, PRINT_LOG_ERROR, and PRINT_TODO_INFO.

{
        GSM_Error err;

        CHECK_PHONE_CONNECTION();
        PRINT_TODO_INFO();

        err = s->Phone.Functions->AddToDo(s, ToDo);
        PRINT_LOG_ERROR(err);
        return err;
}

GSM_DeleteAllToDo()

GSM_Error GSM_DeleteAllToDo

(

GSM_StateMachine *

s

)

Deletes all todo entries in phone.

Parameters

s	State machine pointer.

Returns

Error code

Deletes all todo entries in phone.

Definition at line 1398 of file api.c.

References CHECK_PHONE_CONNECTION, GSM_Phone_Functions::DeleteAllToDo, GSM_Phone::Functions, _GSM_StateMachine::Phone, and PRINT_LOG_ERROR.

{
        GSM_Error err;

        CHECK_PHONE_CONNECTION();

        err = s->Phone.Functions->DeleteAllToDo(s);
        PRINT_LOG_ERROR(err);
        return err;
}

GSM_DeleteToDo()

GSM_Error GSM_DeleteToDo	(	GSM_StateMachine *	s,
		GSM_ToDoEntry *	ToDo
	)

Deletes ToDo entry in phone.

Parameters

s	State machine pointer.
ToDo	ToDo to delete, only location is actually used.

Returns

Error code

Deletes ToDo entry in phone.

Definition at line 1384 of file api.c.

References CHECK_PHONE_CONNECTION, GSM_Phone_Functions::DeleteToDo, GSM_Phone::Functions, _GSM_StateMachine::Phone, PRINT_LOG_ERROR, and PRINT_TODO_INFO.

{
        GSM_Error err;

        CHECK_PHONE_CONNECTION();
        PRINT_TODO_INFO();

        err = s->Phone.Functions->DeleteToDo(s, ToDo);
        PRINT_LOG_ERROR(err);
        return err;
}

GSM_EncodeVTODO()

GSM_Error GSM_EncodeVTODO	(	char *	Buffer,
		const size_t	buff_len,
		size_t *	Length,
		const GSM_ToDoEntry *	note,
		const gboolean	header,
		const GSM_VToDoVersion	Version
	)

Encodes vTodo 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 vTodo to create.

Returns

Error code.

Definition at line 1038 of file gsmcal.c.

References GSM_SubToDoEntry::Date, GSM_DateTime::Day, GSM_ToDoEntry::Entries, GSM_ToDoEntry::EntriesNum, GSM_SubToDoEntry::EntryType, ERR_NONE, GSM_CAL_BIRTHDAY, GSM_Priority_High, GSM_Priority_INVALID, GSM_Priority_Low, GSM_Priority_Medium, GSM_Priority_None, GSM_Translate_Category_To_VCal(), GSM_DateTime::Hour, GSM_ToDoEntry::Location, GSM_DateTime::Minute, GSM_DateTime::Month, Mozilla_VToDo, GSM_SubToDoEntry::Number, GSM_ToDoEntry::Priority, GSM_SubToDoEntry::Text, TODO_ALARM_DATETIME, TODO_CATEGORY, TODO_COMPLETED, TODO_COMPLETED_DATETIME, TODO_CONTACTID, TODO_DESCRIPTION, TODO_END_DATETIME, TODO_LAST_MODIFIED, TODO_LOCATION, TODO_LUID, TODO_PHONE, TODO_PRIVATE, TODO_SILENT_ALARM_DATETIME, TODO_START_DATETIME, TODO_TEXT, GSM_ToDoEntry::Type, VC_StoreDateTime(), VC_StoreLine(), VC_StoreText(), and GSM_DateTime::Year.

Referenced by GSM_EncodeMultiPartSMS().

{
        char            category[100];
        int             i;
        GSM_Error error;

        /* Write header */
        if (header) {
                error = VC_StoreLine(Buffer, buff_len, Length,  "BEGIN:VCALENDAR");
                if (error != ERR_NONE) return error;
                error = VC_StoreLine(Buffer, buff_len, Length,  "VERSION:%s", Version == Mozilla_VToDo ? "2.0" : "1.0");
                if (error != ERR_NONE) return error;
        }
        error = VC_StoreLine(Buffer, buff_len, Length,  "BEGIN:VTODO");
        if (error != ERR_NONE) return error;

        if (Version == Mozilla_VToDo) {
                /* Mozilla Calendar needs UIDs. http://www.innerjoin.org/iCalendar/events-and-uids.html */
                error = VC_StoreLine(Buffer, buff_len, Length,  "UID:calendar-%i",note->Location);
                if (error != ERR_NONE) return error;
                error = VC_StoreLine(Buffer, buff_len, Length,  "STATUS:CONFIRMED");
                if (error != ERR_NONE) return error;
        }

        if (Version == Mozilla_VToDo) {
                switch (note->Priority) {
                        case GSM_Priority_None  :
                        case GSM_Priority_INVALID:
                                error = VC_StoreLine(Buffer, buff_len, Length,  "PRIORITY:0");
                                if (error != ERR_NONE) return error;
                                break;
                        case GSM_Priority_Low   :
                                error = VC_StoreLine(Buffer, buff_len, Length,  "PRIORITY:1");
                                if (error != ERR_NONE) return error;
                                break;
                        case GSM_Priority_Medium:
                                error = VC_StoreLine(Buffer, buff_len, Length,  "PRIORITY:5");
                                if (error != ERR_NONE) return error;
                                break;
                        case GSM_Priority_High  :
                                error = VC_StoreLine(Buffer, buff_len, Length,  "PRIORITY:9");
                                if (error != ERR_NONE) return error;
                                break;
                }
        } else {
                switch (note->Priority) {
                        case GSM_Priority_None  :
                        case GSM_Priority_INVALID:
                                error = VC_StoreLine(Buffer, buff_len, Length,  "PRIORITY:0");
                                if (error != ERR_NONE) return error;
                                break;
                        case GSM_Priority_Low   :
                                error = VC_StoreLine(Buffer, buff_len, Length,  "PRIORITY:1");
                                if (error != ERR_NONE) return error;
                                break;
                        case GSM_Priority_Medium:
                                error = VC_StoreLine(Buffer, buff_len, Length,  "PRIORITY:2");
                                if (error != ERR_NONE) return error;
                                break;
                        case GSM_Priority_High  :
                                error = VC_StoreLine(Buffer, buff_len, Length,  "PRIORITY:3");
                                if (error != ERR_NONE) return error;
                                break;
                }
        }
        /* Store category */
        GSM_Translate_Category_To_VCal(category, note->Type);
        error = VC_StoreLine(Buffer, buff_len, Length,  "CATEGORIES:%s", category);
        if (error != ERR_NONE) return error;

        /* Loop over entries */
        for (i=0; i < note->EntriesNum; i++) {
                switch (note->Entries[i].EntryType) {
                        case TODO_END_DATETIME :
                                if (note->Entries[i].Date.Year   != 2037        &&
                                    note->Entries[i].Date.Month  != 12  &&
                                    note->Entries[i].Date.Day    != 31  &&
                                    note->Entries[i].Date.Hour   != 23  &&
                                    note->Entries[i].Date.Minute != 59 ) {
                                        error = VC_StoreDateTime(Buffer, buff_len, Length, &note->Entries[i].Date, "DUE");
                                        if (error != ERR_NONE) return error;
                                }
                                break;
                        case TODO_ALARM_DATETIME :
                                /* Disable alarm for birthday entries. Mozilla would generate an alarm before birth! */
                                if (Version != Mozilla_VToDo || note->Type != GSM_CAL_BIRTHDAY) {
                                        error = VC_StoreDateTime(Buffer, buff_len, Length, &note->Entries[i].Date, "AALARM");
                                        if (error != ERR_NONE) return error;
                                }
                                break;
                        case TODO_SILENT_ALARM_DATETIME:
                                /* Disable alarm for birthday entries. Mozilla would generate an alarm before birth! */
                                if (Version != Mozilla_VToDo || note->Type != GSM_CAL_BIRTHDAY) {
                                        error = VC_StoreDateTime(Buffer, buff_len, Length, &note->Entries[i].Date, "DALARM");
                                        if (error != ERR_NONE) return error;
                                }
                                break;
                        case TODO_START_DATETIME:
                                error = VC_StoreDateTime(Buffer, buff_len, Length, &note->Entries[i].Date, "DTSTART");
                                if (error != ERR_NONE) return error;
                                break;
                        case TODO_COMPLETED_DATETIME:
                                error = VC_StoreDateTime(Buffer, buff_len, Length, &note->Entries[i].Date, "COMPLETED");
                                if (error != ERR_NONE) return error;
                                break;
                        case TODO_LAST_MODIFIED:
                                error = VC_StoreDateTime(Buffer, buff_len, Length, &note->Entries[i].Date, "LAST-MODIFIED");
                                if (error != ERR_NONE) return error;
                                break;
                        case TODO_TEXT:
                                error = VC_StoreText(Buffer, buff_len, Length, note->Entries[i].Text, "SUMMARY", Version == Mozilla_VToDo);
                                if (error != ERR_NONE) return error;
                                break;
                        case TODO_DESCRIPTION:
                                error = VC_StoreText(Buffer, buff_len, Length, note->Entries[i].Text, "DESCRIPTION", Version == Mozilla_VToDo);
                                if (error != ERR_NONE) return error;
                                break;
                        case TODO_PHONE:
                                /* There is no specific field for phone number, use description */
                                error = VC_StoreText(Buffer, buff_len, Length, note->Entries[i].Text, "DESCRIPTION", Version == Mozilla_VToDo);
                                if (error != ERR_NONE) return error;
                                break;
                        case TODO_LOCATION:
                                error = VC_StoreText(Buffer, buff_len, Length, note->Entries[i].Text, "LOCATION", Version == Mozilla_VToDo);
                                if (error != ERR_NONE) return error;
                                break;
                        case TODO_LUID:
                                error = VC_StoreText(Buffer, buff_len, Length, note->Entries[i].Text, "X-IRMC-LUID", Version == Mozilla_VToDo);
                                if (error != ERR_NONE) return error;
                                break;
                        case TODO_PRIVATE:
                                if (note->Entries[i].Number == 0) {
                                        error = VC_StoreLine(Buffer, buff_len, Length,  "CLASS:PUBLIC");
                                        if (error != ERR_NONE) return error;
                                } else {
                                        error = VC_StoreLine(Buffer, buff_len, Length,  "CLASS:PRIVATE");
                                        if (error != ERR_NONE) return error;
                                }
                                break;
                        case TODO_COMPLETED:
                                if (note->Entries[i].Number == 1) {
                                        error = VC_StoreLine(Buffer, buff_len, Length,  "STATUS:COMPLETED");
                                        if (error != ERR_NONE) return error;
                                        error = VC_StoreLine(Buffer, buff_len, Length,  "PERCENT-COMPLETE:100");
                                        if (error != ERR_NONE) return error;
                                } else {
                                        error = VC_StoreLine(Buffer, buff_len, Length,  "STATUS:NEEDS ACTION");
                                        if (error != ERR_NONE) return error;
                                }
                                break;
                        case TODO_CONTACTID:
                        case TODO_CATEGORY:
                                /* Not supported */
                                break;
                }
        }

        error = VC_StoreLine(Buffer, buff_len, Length,  "END:VTODO");
        if (error != ERR_NONE) return error;
        if (header) {
                error = VC_StoreLine(Buffer, buff_len, Length,  "END:VCALENDAR");
                if (error != ERR_NONE) return error;
        }

        return ERR_NONE;
}

GSM_GetNextToDo()

GSM_Error GSM_GetNextToDo	(	GSM_StateMachine *	s,
		GSM_ToDoEntry *	ToDo,
		gboolean	start
	)

Reads ToDo from phone.

Parameters

s	State machine pointer.
ToDo	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

Reads ToDo from phone.

Definition at line 1341 of file api.c.

References CHECK_PHONE_CONNECTION, GSM_Phone::Functions, GSM_Phone_Functions::GetNextToDo, _GSM_StateMachine::Phone, PRINT_LOG_ERROR, PRINT_START, and PRINT_TODO_INFO.

{
        GSM_Error err;

        CHECK_PHONE_CONNECTION();
        PRINT_START();
        PRINT_TODO_INFO();

        err = s->Phone.Functions->GetNextToDo(s, ToDo, start);
        PRINT_LOG_ERROR(err);
        return err;
}

GSM_GetToDo()

GSM_Error GSM_GetToDo	(	GSM_StateMachine *	s,
		GSM_ToDoEntry *	ToDo
	)

Reads ToDo from phone.

Parameters

s	State machine pointer.
ToDo	Storage for note.

Returns

Error code

Reads ToDo from phone.

Definition at line 1327 of file api.c.

References CHECK_PHONE_CONNECTION, GSM_Phone::Functions, GSM_Phone_Functions::GetToDo, _GSM_StateMachine::Phone, PRINT_LOG_ERROR, and PRINT_TODO_INFO.

{
        GSM_Error err;

        CHECK_PHONE_CONNECTION();
        PRINT_TODO_INFO();

        err = s->Phone.Functions->GetToDo(s, ToDo);
        PRINT_LOG_ERROR(err);
        return err;
}

GSM_GetToDoStatus()

GSM_Error GSM_GetToDoStatus	(	GSM_StateMachine *	s,
		GSM_ToDoStatus *	status
	)

Gets status of ToDos (count of used entries).

Parameters

s	State machine pointer.
status	Storage for todo status.

Returns

Error code

Gets status of ToDos (count of used entries).

Definition at line 1314 of file api.c.

References CHECK_PHONE_CONNECTION, GSM_Phone::Functions, GSM_Phone_Functions::GetToDoStatus, _GSM_StateMachine::Phone, and PRINT_LOG_ERROR.

{
        GSM_Error err;

        CHECK_PHONE_CONNECTION();

        err = s->Phone.Functions->GetToDoStatus(s, status);
        PRINT_LOG_ERROR(err);
        return err;
}

GSM_SetToDo()

GSM_Error GSM_SetToDo	(	GSM_StateMachine *	s,
		GSM_ToDoEntry *	ToDo
	)

Sets ToDo in phone.

Parameters

s	State machine pointer.
ToDo	ToDo to set, should contain valid location.

Returns

Error code

Sets ToDo in phone.

Definition at line 1356 of file api.c.

References CHECK_PHONE_CONNECTION, GSM_Phone::Functions, _GSM_StateMachine::Phone, PRINT_LOG_ERROR, PRINT_TODO_INFO, and GSM_Phone_Functions::SetToDo.

{
        GSM_Error err;

        CHECK_PHONE_CONNECTION();
        PRINT_TODO_INFO();

        err = s->Phone.Functions->SetToDo(s, ToDo);
        PRINT_LOG_ERROR(err);
        return err;
}