WebService::Pushover(3)User Contributed Perl DocumentatioWnebService::Pushover(3)



NNAAMMEE
       WebService::Pushover - interface to Pushover API

VVEERRSSIIOONN
       This document describes WebService::Pushover version 0.0.8.

SSYYNNOOPPSSIISS
           use WebService::Pushover;

           my $push = WebService::Pushover->new
               or die( "Unable to instantiate WebService::Pushover.\n" );

           my %params = (
               token => 'PUSHOVER API TOKEN',
               user => 'PUSHOVER USER TOKEN',
               message => 'test test test',
           );

           my $status = $push->push( %params );

DDEESSCCRRIIPPTTIIOONN
       This module provides a Perl wrapper around the Pushover (
       <http://pushover.net> ) RESTful API.  You'll need to register with
       Pushover to obtain an API token for yourself and for your application
       before you'll be able to do anything with this module.

IINNTTEERRFFAACCEE
       _n_e_w_(_)
           Inherited from WebService::Simple, and takes all the same
           arguments; you shouldn't need to pass any under normal use.

       push(_%_p_a_r_a_m_s)
           _p_u_s_h_(_) sends a message to Pushover and returns a scalar reference
           representation of the message status.  The following are valid
           parameters:

           token RREEQQUUIIRREEDD
               The Pushover application token, obtained by registering at
               <http://pushover.net/apps>.

           user RREEQQUUIIRREEDD
               The Pushover user token, obtained by registering at
               <http://pushover.net>.

           device OOPPTTIIOONNAALL
               The Pushover device name; if not supplied, the user will be
               validated if at least one device is registered to that user.

           title OOPPTTIIOONNAALL
               A string that will appear as the title of the message; if not
               supplied, the name of the application registered to the
               application token will appear.

           message RREEQQUUIIRREEDD
               A string that will appear as the body of the message.

           timestamp OOPPTTIIOONNAALL
               The desired message timestamp, in Unix epoch seconds.

           priority OOPPTTIIOONNAALL
               Set this value to "1" to mark the message as high priority, set
               it to "-1" to mark the message as low priority, or set it to
               "0" or leave it unset for standard priority.

           url OOPPTTIIOONNAALL
               A string that will be attached to the message as a
               supplementary URL.

           url_title OOPPTTIIOONNAALL
               A string that will be displayed as the title of any
               supplementary URL.

       tokens(_%_p_a_r_a_m_s)
           _t_o_k_e_n_s_(_) sends an application token and a user token to Pushover
           and returns a scalar reference representation of the validity of
           those tokens.  The following are valid parameters:

           token RREEQQUUIIRREEDD
               The Pushover application token, obtained by registering at
               <http://pushover.net/apps>.

           user RREEQQUUIIRREEDD
               The Pushover user token, obtained by registering at
               <http://pushover.net>.

           device OOPPTTIIOONNAALL
               The Pushover device name; if not supplied, the message will go
               to all devices registered to the user token.

DDIIAAGGNNOOSSTTIICCSS
       Inspect the value returned by _p_u_s_h_(_), which will be a Perl data
       structure parsed from the JSON response returned by the Pushover API.
       Under normal operation it will contain one key, "status", with a value
       of "1"; in the event of an error, there will also be an "errors" key.

DDEEPPEENNDDEENNCCIIEESS
       DateTime
       DateTime::Format::Strptime
       Params::Validate
       Readonly
       URI
       WebService::Simple

BBUUGGSS AANNDD LLIIMMIITTAATTIIOONNSS
       No bugs have been reported.

       Please report any bugs or feature requests to
       "bug-webservice-pushover@rt.cpan.org", or through the web interface at
       <http://rt.cpan.org>.

AAUUTTHHOORR
       Steve Huff  "<shuff@cpan.org>"

LLIICCEENNCCEE AANNDD CCOOPPYYRRIIGGHHTT
       Copyright (c) 2012, Steve Huff "<shuff@cpan.org>". All rights reserved.

       This module is free software; you can redistribute it and/or modify it
       under the same terms as Perl itself. See perlartistic.

DDIISSCCLLAAIIMMEERR OOFF WWAARRRRAANNTTYY
       BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
       FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT
       WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER
       PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND,
       EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
       WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE
       ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH
       YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL
       NECESSARY SERVICING, REPAIR, OR CORRECTION.

       IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
       WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
       REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE
       TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR
       CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
       SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
       RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
       FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
       SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
       DAMAGES.



perl v5.12.3                      2013-01-29           WebService::Pushover(3)