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

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

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.
MethodcanRegisterForContactNotifications
Description

Tests if this user can register for Contact 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 contacts 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.
MethodreliableContactNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodunreliableContactNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodacknowledgeContactNotification
Description

Acknowledge a contact notification.

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

Register for notifications of new contacts. ContactReceiver.newContacts() is invoked when a new Contact is created.

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

Register for notifications of new contacts for the given genus Type. ContactReceiver.newContacts() is invoked when a new Contact is created.

Parametersosid.type.TypecontactGenusTypethe contact genus type to monitor
ErrorsNULL_ARGUMENT contactGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewContactsForReference
Description

Register for notifications of new contacts for the given reference Id. ContactReceiver.newContacts() is invoked when a new Contact is created.

Parametersosid.id.IdreferenceIdthe Id of the reference to monitor
ErrorsNULL_ARGUMENT referenceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewContactsForAddress
Description

Register for notifications of new contacts for the given reference Id. ContactReceiver.newContacts() is invoked when a new Contact is created.

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.
MethodregisterForChangedContacts
Description

Registers for notification of updated contacts. ContactReceiver.changedContacts() is invoked when a contact is changed.

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

Register for notifications of changed contacts for the given contact genus Type. ContactReceiver.changedContacts() is invoked when a Contact for the genus type is changed.

Parametersosid.type.TypecontactGenusTypethe contact genus type to monitor
ErrorsNULL_ARGUMENT contactGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedContactsForReference
Description

Register for notifications of changed contacts for the given reference Id. ContactReceiver.changedContacts() is invoked when a Contact for the reference is changed.

Parametersosid.id.IdreferenceIdthe Id of the reference to monitor
ErrorsNULL_ARGUMENT referenceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedContactsForAddress
Description

Register for notifications of changed contacts for the given address Id. ContactReceiver.changedContacts() is invoked when a Contact for the 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.
MethodregisterForChangedContact
Description

Registers for notification of an updated contact. ContactReceiver.changedContact() is invoked when the specified contact is changed.

Parametersosid.id.IdcontactIdthe Id of the Contact to monitor
ErrorsNULL_ARGUMENT contactId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedContacts
Description

Registers for notification of deleted contacts. ContactReceiver.deletedContacts() is invoked when a contact is deleted.

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

Register for notifications of deleted contacts for the given contact genus Type. ContactReceiver.deletedContacts() is invoked when a Contact for the genus type is deleted.

Parametersosid.type.TypecontactGenusTypethe contact genus type to monitor
ErrorsNULL_ARGUMENT contactGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedContactsForReference
Description

Register for notifications of deleted contacts for the given reference Id. ContactReceiver.deletedContacts() is invoked when a Contact for the reference is deleted.

Parametersosid.id.IdreferenceIdthe Id of the reference to monitor
ErrorsNULL_ARGUMENT referenceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedContactsForAddress
Description

Register for notifications of deleted contacts for the given address Id. ContactReceiver.deletedContacts() is invoked when a Contact for the 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.
MethodregisterForDeletedContact
Description

Registers for notification of a deleted contact. ContactReceiver.deletedContacts() is invoked when the specified contact is deleted.

Parametersosid.id.IdcontactIdthe Id of the Contact to monitor
ErrorsNULL_ARGUMENT contactId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.