Interface | osid.contact.AddressBookNotificationSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods to receive notifications on
adds/changes to Notifications are triggered with changes to the | ||
Method | canRegisterForAddressBookNotifications | ||
Description |
Tests if this user can register for | ||
Return | boolean | false if notification methods are not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | reliableAddressBookNotifications | ||
Description |
Reliable notifications are desired. In reliable mode,
notifications are to be acknowledged using | ||
Compliance | mandatory | This method is must be implemented. | |
Method | unreliableAddressBookNotifications | ||
Description |
Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | acknowledgeAddressBookNotification | ||
Description |
Acknowledge an address book notification. | ||
Parameters | osid.id.Id | notificationId | the Id of the notification |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewAddressBooks | ||
Description |
Register for notifications of new address books. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedAddressBooks | ||
Description |
Registers for notification of updated address books.
| ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedAddressBook | ||
Description |
Registers for notification of an updated address book.
| ||
Parameters | osid.id.Id | addressBookId | the Id of the AddressBook to monitor |
Errors | NULL_ARGUMENT | addressBookId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedAddressBooks | ||
Description |
Registers for notification of deleted address books.
| ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedAddressBook | ||
Description |
Registers for notification of a deleted address book.
| ||
Parameters | osid.id.Id | addressBookId | the Id of the AddressBook to monitor |
Errors | NULL_ARGUMENT | addressBookId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedAddressBookHierarchy | ||
Description |
Registers for notification of an updated address book
hierarchy structure. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedAddressBookHierarchyForAncestors | ||
Description |
Registers for notification of an updated address book
hierarchy structure. | ||
Parameters | osid.id.Id | addressBookId | the Id of the AddressBook node to monitor |
Errors | NULL_ARGUMENT | addressBookId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedAddressBookHierarchyForDescendants | ||
Description |
Registers for notification of an updated address book
hierarchy structure. | ||
Parameters | osid.id.Id | addressBookId | the Id of the AddressBook node to monitor |
Errors | NULL_ARGUMENT | addressBookId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |