NAME

WWW::CheckPad::CheckList - A class to control checklist of check*pad.

SYNOPSIS

See the WWW::CheckPad

DESCRIPTION

WWW::CheckPad::CheckListはcheck*padのチェックリストをコントロールするクラス です。このクラスを通じて、チェックリストの追加・更新・削除を行うことが可能 です。現在、対応していない主要な機能として下記があります。

１．公開・非公開機能 ２．公開されたチェックリストの取得

Class Method

retrieve_all

  my @checklists = WWW::CheckPad::CheckList->retrieve_all();

retrieve_allは現在ログインしているユーザの全チェックリストを返します。

retrieve

  my $checklist = WWW::CheckPad::CheckList->retrieve($checklist_id);

retrieveは$checklist_idで指定されたチェックリストを返します。ただし、 この$checklist_idが現在ログインしているユーザのチェックリストを指している 必要があります。現在ログインしているユーザのチェックリスト内で見つからない 時はundefを返します。

insert

  my $checklist = WWW::CheckPad::CheckList->insert({title => 'title of list'});
新しいチェックリストを作成し、保存します。

Instance Method

id

  my $checklist_id = $checklist->id();

チェックリストのIDを返す。

title

  my $checklist_title = $checklist->title();
  $checklist->title('title of checklist');

チェックリストのタイトルを返す。引数を与えた時はチェックリストのタイトルを変更する。

update

  $checklist->update();

チェックリストの情報を更新します。これにより更新される情報はタイトルだけ なので、下記のようなコーディングが良く使われます。

  $checklist->title('update title'); ## update the title
  $checklist->update();

delete

  $checklist->delete();

チェックリストを削除します。

add_checkitem

  my $checkitem = $checklist->add_checkitem('new todo item');

新しいTodo項目をこのチェックリストに追加します。

checkitems

  my @checkitems = $checklist->checkitems();

このチェックリストに属する、すべてのTodo項目を返します。

SEE ALSO

WWW::CheckPad

WWW::CheckPad::CheckItem

AUTHOR

Ken Takeshige, <ken.takeshige@gmail.com>

http://d.hatena.ne.jp/ya_ken/

COPYRIGHT AND LICENSE

Copyright (C) 2006 by Ken Takeshige

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.6 or, at your option, any later version of Perl 5 you may have available.

cpanm WWW::CheckPad

perl -MCPAN -e shell
install WWW::CheckPad