You are currently viewing a snapshot of www.mozilla.org taken on April 21, 2008. Most of this content is highly out of date (some pages haven't been updated since the project began in 1998) and exists for historical purposes only. If there are any pages on this archive site that you think should be added back to www.mozilla.org, please file a bug.

Skip to main content

TOC PREV NEXT INDEX

Embedding Gecko API

nsIObserverService

Service allows a client listener (nsIObserver ) to register and unregister for notifications ofa specific string referenced topic. Service also provides a way to notify registered listeners and a way to enumerate registered client listeners

Methods
addObserver

Registers a given listener for a notifications regarding the specified topic.

Syntax: 

void nsIObserverService::addObserver(
	in nsIObserver anObserver,in string aTopic,
	in boolean ownsWeak)

Parameters:

anObserver: The interface pointer to the object which will receive notifications.
aTopic: The notification topic or subject.
ownsWeak: If set to FALSE, the nsIObserverService will hold a strong reference to anObserver. If set to TRUE and anObserver supports the nsIWeakReference interface, a weak reference will be held. Otherwise an error will be returned.

nsresult:

NS_OK if successful.
removeObserver

Unregisters a given listener from notifications regarding the specified topic.

Syntax: 

void nsIObserverService::removeObserver(
	in nsIObserver anObserver,in string aTopic)

Parameters:

anObserver: The interface pointer to the object which should stop receiving notifications.
aTopic: The notification topic or subject.

nsresult:

NS_OK if successful.
notifyObservers

Notifies all registered listeners of the given topic.

Syntax: 

void nsIObserverService::notifyObservers(
	in nsISupports aSubject,in string aTopic,
	in wstring someData)

Parameters:

aSubject: Notification specific interface pointer.
aTopic: The notification topic or subject.
someData: Notification specific wide string.

nsresult:

NS_OK if successful.
enumerateObservers

Returns an enumeration of all registered listeners.

See also: nsISimpleEnumerator.

Syntax: 

nsISimpleEnumerator nsIObserverService::enumerateObservers(
	in string aTopic)

Parameters:

aTopic: The notification topic or subject.

nsresult:

NS_OK if successful.
Written by:Ellen Evans | Comments, questions, complaints? Bug 143387
TOC PREV NEXT INDEX