.\" Automatically generated by Pod::Man 2.1801 (Pod::Simple 3.05) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .ie \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} .el \{\ . de IX .. .\} .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "Net::Hiveminder 3pm" .TH Net::Hiveminder 3pm "2009-07-09" "perl v5.10.0" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" Net::Hiveminder \- Perl interface to hiveminder.com .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 4 \& use Net::Hiveminder; \& my $hm = Net::Hiveminder\->new(use_config => 1); \& print $hm\->todo; \& $hm\->create_task("Boy these pretzels are making me thirsty [due tomorrow]"); .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" Hiveminder is a collaborate todo list organizer, built with Jifty. .PP This module uses Hiveminder's \s-1REST\s0 \s-1API\s0 to let you manage your tasks any way you want to. .PP This module is built on top of Net::Jifty. Consult that module's documentation for the lower-level interface. .SS "display_tasks [\s-1ARGS\s0], \s-1TASKS\s0" .IX Subsection "display_tasks [ARGS], TASKS" This will take a list of hash references, \f(CW\*(C`TASKS\*(C'\fR, and convert each to a human-readable form. .PP In scalar context it will return the readable forms of these tasks joined by newlines. .PP Passing options into this is somewhat tricky, because tasks are currently regular hashes. You may pass arguments to this method as such: .PP .Vb 1 \& $hm\->display_tasks([arg1 => \*(Aqval1\*(Aq, arg2 => \*(Aqval2\*(Aq], @tasks) .Ve .PP The arguments currently respected are: .IP "linkify_locator" 4 .IX Item "linkify_locator" Make the record locator (\f(CW\*(C`#foo\*(C'\fR) into an \s-1HTML\s0 link, pointing to the task on \&\f(CW\*(C`site\*(C'\fR. .SS "get_tasks \s-1ARGS\s0" .IX Subsection "get_tasks ARGS" Runs a search with \f(CW\*(C`ARGS\*(C'\fR for tasks. There are no defaults here, so this can be used for anything. .PP Returns a list of hash references, each one being a task. Use \f(CW\*(C`display_tasks\*(C'\fR if necessary. .SS "todo_tasks [\s-1ARGS\s0]" .IX Subsection "todo_tasks [ARGS]" Returns a list of hash references, each one a task. This uses the same query that the home page of Hiveminder uses. The optional \f(CW\*(C`ARGS\*(C'\fR will be passed as well so you can narrow down your todo list. .SS "todo [\s-1ARGS\s0]" .IX Subsection "todo [ARGS]" Returns a list of tasks in human-readable form. The optional \f(CW\*(C`ARGS\*(C'\fR will be passed as well so you can narrow down your todo list. .PP In scalar context it will return the concatenation of the tasks. .PP If the first argument is an array reference, it will be passed to \&\*(L"display_tasks\*(R" as options. .PP For example, to display tasks due today (with color): .PP .Vb 1 \& print scalar $hm\->todo([color => 1], due => "today"); .Ve .SS "create_task \s-1SUMMARY\s0, \s-1ARGS\s0" .IX Subsection "create_task SUMMARY, ARGS" Creates a new task with \f(CW\*(C`SUMMARY\*(C'\fR. You may also specify arguments such as what tags the task will have. .SS "read_task \s-1LOCATOR\s0" .IX Subsection "read_task LOCATOR" Load task \f(CW\*(C`LOCATOR\*(C'\fR. .SS "update_task \s-1LOCATOR\s0, \s-1ARGS\s0" .IX Subsection "update_task LOCATOR, ARGS" Update task \f(CW\*(C`LOCATOR\*(C'\fR with \f(CW\*(C`ARGS\*(C'\fR. .SS "delete_task \s-1LOCATOR\s0" .IX Subsection "delete_task LOCATOR" Delete task \f(CW\*(C`LOCATOR\*(C'\fR. .SS "bulk_update \s-1ARGS\s0" .IX Subsection "bulk_update ARGS" Bulk-updates the given tasks. You can pass tasks in with one or more of the following: .IP "tasks" 4 .IX Item "tasks" An array reference of task hashes or locators, or a space-delimited string of locators. .IP "ids" 4 .IX Item "ids" An array reference or space-delimited string of task IDs. .SS "complete_tasks \s-1TASKS\s0" .IX Subsection "complete_tasks TASKS" Marks the list of tasks or locators as complete. .SS "braindump TEXT[, \s-1ARGS\s0]" .IX Subsection "braindump TEXT[, ARGS]" Braindumps \f(CW\*(C`TEXT\*(C'\fR. .PP Optional arguments: .IP "tokens => string | arrayref" 4 .IX Item "tokens => string | arrayref" tokens may be used to provide default attributes to all the braindumped tasks (this is part of what the filter feature of Hiveminder's \s-1IM\s0 bot does). .IP "returns => 'ids' | 'tasks'" 4 .IX Item "returns => 'ids' | 'tasks'" Return the affected task IDs, or the tasks themselves, instead of a summary of the changes made. .SS "upload_text \s-1TEXT\s0" .IX Subsection "upload_text TEXT" Uploads \f(CW\*(C`TEXT\*(C'\fR to BTDT::Action::UploadTasks. .SS "upload_file \s-1FILENAME\s0" .IX Subsection "upload_file FILENAME" Uploads \f(CW\*(C`FILENAME\*(C'\fR to BTDT::Action::UploadTasks. .SS "download_text" .IX Subsection "download_text" Downloads your tasks. This also gets the metadata so that you can edit the text and upload it, and it'll make the same changes to your task list. .PP This does not currently accept query arguments, because Hiveminder expects a \&\*(L"/not/owner/me/group/personal\*(R" type argument string, when all we can produce is \&\*(L"owner_not => 'me', group => 'personal'\*(R" .SS "download_file \s-1FILENAME\s0" .IX Subsection "download_file FILENAME" Downloads your tasks and puts them into \f(CW\*(C`FILENAME\*(C'\fR. .PP This does not currently accept query arguments, because Hiveminder expects a \&\*(L"/not/owner/me/group/personal\*(R" type argument string, when all we can produce is \&\*(L"owner_not => 'me', group => 'personal'\*(R" .SS "priority (\s-1NUMBER\s0 | \s-1TASK\s0) \-> Maybe String" .IX Subsection "priority (NUMBER | TASK) -> Maybe String" Returns the \*(L"word\*(R" of a priority. One of: lowest, low, normal, high, highest. If the priority is out of range, \f(CW\*(C`undef\*(C'\fR will be returned. .SS "done \s-1LOCATORS\s0" .IX Subsection "done LOCATORS" Marks the given tasks as complete. .SS "loc2id (LOCATOR|TASK)s \-> IDs" .IX Subsection "loc2id (LOCATOR|TASK)s -> IDs" Transforms the given record locators (or tasks) to regular IDs. .SS "id2loc IDs \-> LOCATORs" .IX Subsection "id2loc IDs -> LOCATORs" Transform the given IDs into record locators. .SS "tasks2ids" .IX Subsection "tasks2ids" Deprecated .SS "comments_on \s-1TASK\s0 \-> (String)s" .IX Subsection "comments_on TASK -> (String)s" Returns a list of the comments on the given task. .SS "comment_on \s-1TASK\s0, \s-1MESSAGE\s0" .IX Subsection "comment_on TASK, MESSAGE" Add a comment to \s-1TASK\s0. .PP This method requires Email::Simple::Creator, which is an optional dependency of Net::Hiveminder. If Creator is unavailable, then this will throw an error. .SS "send_feedback \s-1TEXT\s0" .IX Subsection "send_feedback TEXT" Sends the given \s-1TEXT\s0 as feedback to the Hiveminder team. .SS "get_task_history \s-1LOCATOR\s0" .IX Subsection "get_task_history LOCATOR" Load the transaction history for task \s-1LOCATOR\s0. .PP Returns an array of transactions looking like: .PP \&\f(CW$VAR1\fR = { 'modified_at' => '2008\-07\-24 15:38:06', 'type' => 'update', 'id' => '1745040', 'task_id' => '433397', 'created_by' => '463' }; .SH "SEE ALSO" .IX Header "SEE ALSO" App::Todo, Jifty, Net::Jifty .SH "AUTHOR" .IX Header "AUTHOR" Shawn M Moore, \f(CW\*(C`\*(C'\fR .SH "BUGS" .IX Header "BUGS" Please report any bugs or feature requests to \&\f(CW\*(C`bug\-net\-hiveminder at rt.cpan.org\*(C'\fR, or through the web interface at . .SH "COPYRIGHT & LICENSE" .IX Header "COPYRIGHT & LICENSE" Copyright 2007\-2009 Best Practical Solutions. .PP This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.