OSID Logo
OSID Specifications
installation package
Version 3.0.0
Release Candidate Preview
Interfaceosid.installation.InstallationNotificationSession
Implementsosid.OsidSession
Description

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

MethodgetSiteId
Description

Gets the Site Id associated with this session.

Returnosid.id.Idthe Site Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetSite
Description

Gets the Site associated with this session.

Returnosid.installation.Sitethe Site associated with this session
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanRegisterForInstallationNotifications
Description

Tests if this user can register for Installation 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 not offer notification functions to unauthorized users.

Returnboolean false if notification methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodregisterForNewInstallations
Description

Register for notifications of new installations. InstallationReceiver.newInstallations() is invoked when a new installation is installed.

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

Registers for notification of deleted installations. InstallationReceiver.deletedInstallations() is invoked when a installation is removed.

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

Registers for notification of a deleted installation. InstallationReceiver.deletedInstallations() is invoked when the specified installation is removed.

Parametersosid.id.IdinstallationIdthe Id of the Installation to monitor
ErrorsNULL_ARGUMENT installationId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.