OSID Logo
OSID Specifications
calendaring package
Version 3.0.0
Release Candidate Preview
Interfaceosid.calendaring.CalendarNotificationSession
Implementsosid.OsidSession
Description

This session defines methods to receive notifications on adds/changes to Calendar objects. This session is intended for consumers needing to synchronize their state with this service without the use of polling. Notifications are cancelled when this session i

MethodcanRegisterForCalendarNotifications
Description

Tests if this user can register for Calendar notifications. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer notification operations.

Returnboolean false if notification methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodreliableCalendarNotifications
Description

Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using acknowledgeCalendarNotification() .

CompliancemandatoryThis method is must be implemented.
MethodunreliableCalendarNotifications
Description

Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.

CompliancemandatoryThis method is must be implemented.
MethodacknowledgeCalendarNotification
Description

Acknowledge a clendar notification.

Parametersosid.id.IdnotificationIdthe Id of the notification
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewCalendars
Description

Register for notifications of new calendars. CalendarReceiver.newCalendars() is invoked when a new Calendar is created.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedCalendars
Description

Registers for notification of updated calendars. CalendarReceiver.changedCalendars() is invoked when a calendar is changed.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedCalendar
Description

Registers for notification of an updated calendar. CalendarReceiver.changedCalendars() is invoked when the specified calendar is changed.

Parametersosid.id.IdcalendarIdthe Id of the calendar to monitor
ErrorsNULL_ARGUMENT calendarId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedCalendars
Description

Registers for notification of deleted calendars. CalendarReceiver.deletedCalendars() is invoked when a calenedar is deleted.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedCalendar
Description

Registers for notification of a deleted calendar. CalendarReceiver.deletedCalendars() is invoked when the specified calendar is deleted.

Parametersosid.id.IdcalendarIdthe Id of the calendar to monitor
ErrorsNULL_ARGUMENT calendarId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedCalendarHierarchy
Description

Registers for notification of an updated calendar hierarchy structure. CalendarReceiver.changedChildOfCalendars() is invoked when a node experiences a change in its children.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedCalendarHierarchyForAncestors
Description

Calendar Receiver.changedChildOfCalendars() is invoked when the specified node or any of its ancestors experiences a change in its children.

Parametersosid.id.IdcalendarIdthe Id of the Calendar node to monitor
ErrorsNULL_ARGUMENT calendarId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedCalendarHierarchyForDescendants
Description

Registers for notification of an updated calendar hierarchy structure. CalendarReceiver.changedChildOfCalendars() is invoked when the specified node or any of its descendants experiences a change in its children.

Parametersosid.id.IdcalendarIdthe Id of the Calendar node to monitor
ErrorsNULL_ARGUMENT calendarId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.