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

This session defines methods to receive asynchronous notifications on adds/changes to OffsetEvent 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 is closed.

The views defined in this session correspond to the views in the OffsetEventLookupSession.

MethodgetCalendarId
Description

Gets the Calendar Id associated with this session.

Returnosid.id.Idthe Calendar Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetCalendar
Description

Gets the Calendar associated with this session.

Returnosid.calendaring.Calendarthe Calendar associated with this session
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanRegisterForOffsetEventNotifications
Description

Tests if this user can register for OffsetEvent 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.
MethoduseFederatedCalendarView
Description

Federates the view for methods in this session. A federated view will include notifications for events in calendars which are children of this calendar in the calendar hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedCalendarView
Description

Isolates the view for methods in this session. An isolated view restricts notifications to this calendar only.

CompliancemandatoryThis method is must be implemented.
MethodreliableOffsetEventNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodunreliableOffsetEventNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodacknowledgeOffsetEventNotification
Description

Acknowledge an offset event notification.

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

Register for notifications of new offset events. OffsetEventReceiver.newOffsetEvents() is invoked when a new offset event is created.

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

Registers for notification of updated offset events. OffsetEventReceiver.changedOffsetEvents() is invoked when an offset event is changed.

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

Registers for notification of an updated offset event. OffsetEventReceiver.changedOffsetEvents() is invoked when the specified offset event is changed.

Parametersosid.id.IdoffsetEventIdthe Id of the OffsetEventId to monitor
ErrorsNULL_ARGUMENT offsetEventId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedOffsetEvents
Description

Registers for notification of deleted offset events. OffsetEventReceiver.deletedOffsetEvents() is invoked when an offset event is removed from this calendar.

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

Registers for notification of a deleted offset event. OffsetEventReceiver.changedOffsetEvents() is invoked when the specified offset event is removed from this calendar.

Parametersosid.id.IdoffsetEventIdthe Id of the OffsetEvent to monitor
ErrorsNULL_ARGUMENT offsetEventid is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.