OSID Logo
OSID Specifications
contact package
Version 3.0.0
Release Candidate Preview
Interfaceosid.contact.AddressBookNotificationSession
Implementsosid.OsidSession
Description

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

Notifications are triggered with changes to the AddressBook object itself. Adding and removing contacts result in notifications available from the notification session for contacts.

MethodcanRegisterForAddressBookNotifications
Description

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

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

CompliancemandatoryThis method is must be implemented.
MethodunreliableAddressBookNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodacknowledgeAddressBookNotification
Description

Acknowledge an address book notification.

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

Register for notifications of new address books. AddressBookReceiver.newAddressBooks() is invoked when a new AddressBook is created.

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

Registers for notification of updated address books. AddressBookReceiver.changedAddressBooks() is invoked when an address book is changed.

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

Registers for notification of an updated address book. AddressBookReceiver.changedAddressBooks() is invoked when the specified address book is changed.

Parametersosid.id.IdaddressBookIdthe Id of the AddressBook to monitor
ErrorsNULL_ARGUMENT addressBookId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedAddressBooks
Description

Registers for notification of deleted address books. AddressBookReceiver.deletedAddressBooks() is invoked when an address book is deleted.

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

Registers for notification of a deleted address book. AddressBookReceiver.deletedAddressBooks() is invoked when the specified address book is deleted.

Parametersosid.id.IdaddressBookIdthe Id of the AddressBook to monitor
ErrorsNULL_ARGUMENT addressBookId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedAddressBookHierarchy
Description

Registers for notification of an updated address book hierarchy structure. AddressBookReceiver.changedChildOfAddressBooks() is invoked when a node experiences a change in its children.

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

Registers for notification of an updated address book hierarchy structure. AddressBookReceiver.changedChildOfAddressBooks() is invoked when the specified node or any of its ancestors experiences a change in its children.

Parametersosid.id.IdaddressBookIdthe Id of the AddressBook node to monitor
ErrorsNULL_ARGUMENT addressBookId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedAddressBookHierarchyForDescendants
Description

Registers for notification of an updated address book hierarchy structure. AddressBookReceiver.changedChildOfAddressBooks() is invoked when the specified node or any of its descendants experiences a change in its children.

Parametersosid.id.IdaddressBookIdthe Id of the AddressBook node to monitor
ErrorsNULL_ARGUMENT addressBookId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.