/ 
WebService-Lingr-Archives-0.03
River stage zero No dependents
/ WebService::Lingr::Archives

NAME

WebService::Lingr::Archives - load archived messages from lingr.com

SYNOPSIS

 use WebService::Lingr::Archives;
 use Encode qw(encode_utf8);

 my $lingr = WebService::Lingr::Archives->new(
     user     => "your lingr username",
     password => "your lingr password",
     app_key  => "your lingr App key",  ## optional
 );

 my @messages = $lingr->get_archives("perl_jp", {limit => 100});

 foreach my $m (@messages) {
     print encode_utf8("[$m->{timestamp}] $m->{id} $m->{nickname} : $m->{text}\n");
 }

DESCRIPTION

This is a front-end module specifically for Lingr archives API.

Lingr (http://lingr.com) is a group chat Web service. WebService::Lingr::Archives uses its Web API to fetch archived message data from a chat room.

CLASS METHODS

$lingr = WebService::Lingr::Archives->new(%args)

The constructor.

Fields in %args are:

user => STR (mandatory)

Username for your Lingr account.

password => STR (mandatory)

Password for your Lingr account.

app_key => STR (optional)

Lingr App key. Although it's not required, you can register your app in http://lingr.com/developer.

api_base => STR (optional, default: "http://lingr.com/api")

API base URL.

user_agent => OBJECT (optional, default: LWP::UserAgent with env_proxy() called)

HTTP UserAgent object to access the API.

OBJECT METHODS

@messages = $lingr->get_archives($room_id[, $options])

Get archived messages from the chat room specified by $room_id.

Optional parameter $options is a hash-ref. Its fields are:

before => MESSAGE ID (optional, default: 99999999)

get_archives() returns messages whose ID is less than this number. By default, before parameter is set to a very big number, meaning get_archives() returns the latest messages.

limit => INT (optional)

Number of messages get_messages() tries to return.

In success, this method returns a list of hash-refs. Each hash-ref represents a message created in the chat room.

In failure, this method dies.

SEE ALSO

AUTHOR

Toshio Ito <toshioito [at] cpan.org>

LICENSE AND COPYRIGHT

Copyright 2013 Toshio Ito.

This program is free software; you can redistribute it and/or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at:

http://www.perlfoundation.org/artistic_license_2_0

Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License. By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.

If your Modified Version has been derived from a Modified Version made by someone other than you, you are nevertheless required to ensure that your Modified Version complies with the requirements of this license.

This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder.

This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement, then this Artistic License to you shall terminate on the date that such litigation is filed.

Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.