The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.

NAME

WaitReSS::User - A WaitReSS user

VERSION

version 0.004

DESCRIPTION

This class represents a WaitReSS user.

ATTRIBUTES

login

The user login. Required, used as unique identifier.

METHODS

new_from_directory

    my $user = WaitReSS::User->new_from_directory( $dir );

Return a new WaitReSS::User loaded with information located in $dir (a Path::Tiny object).

save

    $user->save;

Save the user main information to be retrieved later on.

delete

    $user->delete;

Delete $user and all its related information. Note that you should also make sure WaitReSS::Users is correctly updated.

register

    $user->register( $url );

Register $url as a feed for $user. Feed is created if needed.

feeds

    my @feeds = $user->feeds;

Return a list of feeds (WaitReSS::Feed objects> that the $user has registered.

unread_items

    my %items = $user->unread_items( [ $id ] );

Return items currently unread by the user. Result is returned as hash, with feed id as the keys, and an array ref of unread items (WaitReSS::Item objects) for this feed id as values.

Restrict to feeds matching $id if it is specified.

AUTHOR

Jerome Quelin <jquelin@gmail.com>

COPYRIGHT AND LICENSE

This software is copyright (c) 2013 by Jerome Quelin.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.