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

This session defines methods to receive notifications on adds/changes to Address 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 Address object itself. Adding and removing contacts result in notifications available from the notification session for contacts.

MethodgetAddressBookId
Description

Gets the AddressBook Id associated with this session.

Returnosid.id.Idthe AddressBook Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetAddressBook
Description

Gets the AddressBook associated with this session.

Returnosid.contact.AddressBookthe address book
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanRegisterForAddressNotifications
Description

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

Federates the view for methods in this session. A federated view will include addresses in address books which are children of this address book in the address book hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedAddressBookView
Description

Isolates the view for methods in this session. An isolated view restricts retrievals to this address book only.

CompliancemandatoryThis method is must be implemented.
MethodreliableAddressNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodunreliableAddressNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodacknowledgeAddressNotification
Description

Acknowledge an address notification.

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

Register for notifications of new addresses. AddressReceiver.newAddresses() is invoked when a new Address is created.

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

Registers for notification of updated addresses. AddressReceiver.changedAddresses() is invoked when an address is changed.

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

Registers for notification of an updated address. AddressReceiver.changedAddresses() is invoked when the specified address is changed.

Parametersosid.id.IdaddressIdthe Id of the Address to monitor
ErrorsNULL_ARGUMENT addressId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedAddresses
Description

Registers for notification of deleted addresses. AddressReceiver.deletedAddresses() is invoked when an address is deleted.

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

Registers for notification of a deleted address. AddressReceiver.deletedAddresses() is invoked when the specified address is deleted.

Parametersosid.id.IdaddressIdthe Id of the Address to monitor
ErrorsNULL_ARGUMENT addressId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.