OSID Logo
OSID Specifications
blogging package
Version 3.0.0
Release Candidate Preview
Interfaceosid.blogging.BlogNotificationSession
Implementsosid.OsidSession
Description

This session defines methods to receive notifications on adds/changes to Blog objects. This session is intended for consumers needing to synchronize their entry with this service without the use of polling. Notifications are cancelled when this session is closed.

MethodcanRegisterForBlogNotifications
Description

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

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

CompliancemandatoryThis method is must be implemented.
MethodunreliableBlogNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodacknowledgeBlogNotification
Description

Acknowledge a blog notification.

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

Register for notifications of new blogs. BlogReceiver.newBlogs() is invoked when a new Blog is created.

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

Registers for notification of updated blogs. BlogReceiver.changedBlogs() is invoked when a blog is changed.

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

Registers for notification of an updated blog. BlogReceiver.changedBlogs() is invoked when the specified blog is changed.

Parametersosid.id.IdblogIdthe Id of the Blog to monitor
ErrorsNULL_ARGUMENT blogId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedBlogs
Description

Registers for notification of deleted blogs. BlogReceiver.deletedBlogs() is invoked when a blog is deleted.

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

Registers for notification of a deleted blog. BlogReceiver.deletedBlogs() is invoked when the specified blog is deleted.

Parametersosid.id.IdblogIdthe Id of the Blog to monitor
ErrorsNULL_ARGUMENT blogId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedBlogHierarchy
Description

Registers for notification of an updated blog hierarchy structure. BlogReceiver.changedChildOfBlogs() is invoked when a node experiences a change in its children.

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

Registers for notification of an updated blog hierarchy structure. BlogReceiver.changedChildOfBlogs() is invoked when the specified node or any of its ancestors experiences a change in its children.

Parametersosid.id.IdblogIdthe Id of the Blog node to monitor
ErrorsNULL_ARGUMENT blogId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedBlogHierarchyForDescendants
Description

Registers for notification of an updated blog hierarchy structure. BlogReceiver.changedChildOfBlogs() is invoked when the specified node or any of its descendants experiences a change in its children.

Parametersosid.id.IdblogIdthe Id of the Blog node to monitor
ErrorsNULL_ARGUMENT blogId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.