File Coverage

blib/lib/Net/API/Telegram/KeyboardButton.pm
Criterion Covered Total %
statement 7 11 63.6
branch n/a
condition n/a
subroutine 3 7 42.8
pod 3 3 100.0
total 13 21 61.9


line stmt bran cond sub pod time code
1             # -*- perl -*-
2             ##----------------------------------------------------------------------------
3             ## Net/API/Telegram/KeyboardButton.pm
4             ## Version 0.1
5             ## Copyright(c) 2019 Jacques Deguest
6             ## Author: Jacques Deguest <jack@deguest.jp>
7             ## Created 2019/05/29
8             ## Modified 2020/05/20
9             ## All rights reserved.
10             ##
11             ## This program is free software; you can redistribute it and/or modify it
12             ## under the same terms as Perl itself.
13             ##----------------------------------------------------------------------------
14             package Net::API::Telegram::KeyboardButton;
15             BEGIN
16             {
17 1     1   1123 use strict;
  1         2  
  1         30  
18 1     1   5 use parent qw( Net::API::Telegram::Generic );
  1         1  
  1         5  
19 1     1   165 our( $VERSION ) = '0.1';
20             };
21              
22 0     0 1   sub request_contact { return( shift->_set_get_scalar( 'request_contact', @_ ) ); }
23              
24 0     0 1   sub request_location { return( shift->_set_get_scalar( 'request_location', @_ ) ); }
25              
26 0     0 1   sub text { return( shift->_set_get_scalar( 'text', @_ ) ); }
27              
28 0     0     sub _is_boolean { return( grep( /^$_[1]$/, qw( request_contact request_location ) ) ); }
29              
30             1;
31              
32             __END__
33              
34             =encoding utf-8
35              
36             =head1 NAME
37              
38             Net::API::Telegram::KeyboardButton - One button of the reply keyboard
39              
40             =head1 SYNOPSIS
41              
42             my $msg = Net::API::Telegram::KeyboardButton->new( %data ) ||
43             die( Net::API::Telegram::KeyboardButton->error, "\n" );
44              
45             =head1 DESCRIPTION
46              
47             L<Net::API::Telegram::KeyboardButton> is a Telegram Message Object as defined here L<https://core.telegram.org/bots/api#keyboardbutton>
48              
49             This module has been automatically generated from Telegram API documentation by the script scripts/telegram-doc2perl-methods.pl.
50              
51             =head1 METHODS
52              
53             =over 4
54              
55             =item B<new>( {INIT HASH REF}, %PARAMETERS )
56              
57             B<new>() will create a new object for the package, pass any argument it might receive
58             to the special standard routine B<init> that I<must> exist.
59             Then it returns what returns B<init>().
60              
61             The valid parameters are as follow. Methods available here are also parameters to the B<new> method.
62              
63             =over 8
64              
65             =item * I<verbose>
66              
67             =item * I<debug>
68              
69             =back
70              
71             =item B<request_contact>( Boolean )
72              
73             Optional. If True, the user's phone number will be sent as a contact when the button is pressed. Available in private chats only
74              
75             =item B<request_location>( Boolean )
76              
77             Optional. If True, the user's current location will be sent when the button is pressed. Available in private chats only
78              
79             =item B<text>( String )
80              
81             Text of the button. If none of the optional fields are used, it will be sent as a message when the button is pressed
82              
83             =back
84              
85             =head1 COPYRIGHT
86              
87             Copyright (c) 2000-2019 DEGUEST Pte. Ltd.
88              
89             =head1 AUTHOR
90              
91             Jacques Deguest E<lt>F<jack@deguest.jp>E<gt>
92              
93             =head1 SEE ALSO
94              
95             L<Net::API::Telegram>
96              
97             =head1 COPYRIGHT & LICENSE
98              
99             Copyright (c) 2018-2019 DEGUEST Pte. Ltd.
100              
101             You can use, copy, modify and redistribute this package and associated
102             files under the same terms as Perl itself.
103              
104             =cut
105