NAME

Jifty::Subs - Configure subscriptions for the current window or session

SYNOPSIS

my $sid = Jifty->subs->add(
   class       => 'Tick',
   queries     => [{ like => '9' }],
   mode        => 'Replace',
   region      => "clock-time",
   render_with => '/fragments/time',
);
Jifty->subs->cancel($sid);

my @sids = Jifty->subs->list;

DESCRIPTION

METHODS

add PARAMHASH

Add a subscription for the current window or session.

Takes the following parameters

class

What class of object shall we subscribe to notifications on

queries

An array of queries to match items of class class against. The implementation of queries is dependent on the type of object events are being recorded against

mode

How should the fragment sent to the client on matching events be rendered. Valid modes are Replace, Bottom and Top

region

The moniker of the region that updates to this subscription should be rendered into

render_with

The path of the fragment used to render items matching this subscription

cancel CHANNEL_ID

Cancels session or window's subscription to CHANNEL_ID

list [window/sessionid]

Returns a lost of channel ids this session or window is subscribed to.