A C D E G H J O P R S

A

act() - Method in interface org.sakaiproject.courier.api.Delivery

Perform any pre-delivery actions.

C

check(Object) - Method in interface org.sakaiproject.courier.api.ObservingCourier

Check to see if we want to process or ignore this update.

clear(String, String) - Method in interface org.sakaiproject.courier.api.CourierService

Clear any pending delivery requests to the particular client window for this element.

clear(String) - Method in interface org.sakaiproject.courier.api.CourierService

Clear any pending delivery requests to this session client window.

clear(String, String) - Static method in class org.sakaiproject.courier.cover.CourierService

clear(String) - Static method in class org.sakaiproject.courier.cover.CourierService

compose() - Method in interface org.sakaiproject.courier.api.Delivery

Compose a javascript message for delivery to the browser client window.

CourierService - Interface in org.sakaiproject.courier.api

CourierService is the Interface for a Sakai service which can be used to push messages from the Sakai server components to the user interface in the browser.

CourierService - Class in org.sakaiproject.courier.cover

CourierService is a static Cover for the CourierService; see that interface for usage details.

CourierService() - Constructor for class org.sakaiproject.courier.cover.CourierService

D

deliver(Delivery) - Method in interface org.sakaiproject.courier.api.CourierService

Queue up a delivery for the client window identified in the Delivery object.

deliver(Delivery) - Static method in class org.sakaiproject.courier.cover.CourierService

Delivery - Interface in org.sakaiproject.courier.api

Delivery is the core interface for things sent to the Courier service that represent various sorts of deliveries to the client windows.

DeliveryProvider - Interface in org.sakaiproject.courier.api

disable() - Method in interface org.sakaiproject.courier.api.ObservingCourier

Disable.

E

enable() - Method in interface org.sakaiproject.courier.api.ObservingCourier

Enable.

G

getAddress() - Method in interface org.sakaiproject.courier.api.Delivery

Access the delivery address.

getDeliveries(String) - Method in interface org.sakaiproject.courier.api.CourierService

Access and de-queue the Deliveries queued up for a particular session client window.

getDeliveries(String, String) - Method in interface org.sakaiproject.courier.api.DeliveryProvider

Access the Deliveries queued up for a particular session client window.

getDeliveries(String) - Static method in class org.sakaiproject.courier.cover.CourierService

getDeliveryId() - Method in interface org.sakaiproject.courier.api.ObservingCourier

getDeliveryProviders() - Method in interface org.sakaiproject.courier.api.CourierService

Access a list of DeliveryProviders registered with the CourierService.

getDeliveryProviders() - Static method in class org.sakaiproject.courier.cover.CourierService

getElement() - Method in interface org.sakaiproject.courier.api.Delivery

Access the HTML Element Id that this delivery is in reference to.

getElementId() - Method in interface org.sakaiproject.courier.api.ObservingCourier

getEnabled() - Method in interface org.sakaiproject.courier.api.ObservingCourier

getInstance() - Static method in class org.sakaiproject.courier.cover.CourierService

Access the component instance: special cover only method.

getInstance() - Static method in class org.sakaiproject.courier.cover.PresenceUpdater

Access the component instance: special cover only method.

getLocation() - Method in interface org.sakaiproject.courier.api.ObservingCourier

H

hasDeliveries(String) - Method in interface org.sakaiproject.courier.api.CourierService

Check to see if there are any deliveries queued up for a particular session client window.

hasDeliveries(String) - Static method in class org.sakaiproject.courier.cover.CourierService

J

justDelivered() - Method in interface org.sakaiproject.courier.api.ObservingCourier

Accept notification that the element has just been delivered.

O

ObservingCourier - Interface in org.sakaiproject.courier.api

ObservingCourier is an observer which uses the courier service to notify when things change.

org.sakaiproject.courier.api - package org.sakaiproject.courier.api

org.sakaiproject.courier.cover - package org.sakaiproject.courier.cover

P

PRESENCE_SERVICE - Static variable in class org.sakaiproject.courier.cover.PresenceUpdater

Service Bean ID for PresenceService, which implements PresenceUpdater to break cross-dependency.

PresenceUpdater - Interface in org.sakaiproject.courier.api

The PresenceUpdater interface is a simple mechanism to access the PresenceService without a cross-module dependency.

PresenceUpdater - Class in org.sakaiproject.courier.cover

PresenceUpdater is a static Cover for the PresenceUpdater; see that interface for usage details.

PresenceUpdater() - Constructor for class org.sakaiproject.courier.cover.PresenceUpdater

R

registerDeliveryProvider(DeliveryProvider) - Method in interface org.sakaiproject.courier.api.CourierService

Register a DeliveryProvider with the CourierService.

S

SERVICE_NAME - Static variable in interface org.sakaiproject.courier.api.CourierService

This string can be used to find the service in the service manager.

SERVICE_NAME - Static variable in class org.sakaiproject.courier.cover.CourierService

setAddress(String) - Method in interface org.sakaiproject.courier.api.Delivery

Set the delivery address.

setDeliveryId(String) - Method in interface org.sakaiproject.courier.api.ObservingCourier

Set the delivery id.

setElement(String) - Method in interface org.sakaiproject.courier.api.Delivery

Set the HTML Element Id that this delivery is in reference to.

setElementId(String) - Method in interface org.sakaiproject.courier.api.ObservingCourier

Set the element id.

setPresence(String) - Method in interface org.sakaiproject.courier.api.PresenceUpdater

Establish or refresh the presence of the current session in a location.

setPresence(String) - Static method in class org.sakaiproject.courier.cover.PresenceUpdater

A C D E G H J O P R S