File Coverage

blib/lib/Net/API/Telegram/ResponseParameters.pm
Criterion Covered Total %
statement 7 9 77.7
branch n/a
condition n/a
subroutine 3 5 60.0
pod 2 2 100.0
total 12 16 75.0


line stmt bran cond sub pod time code
1             # -*- perl -*-
2             ##----------------------------------------------------------------------------
3             ## Telegram API - ~/lib/Net/API/Telegram/ResponseParameters.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 2019/11/01
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::ResponseParameters;
15             BEGIN
16             {
17 1     1   1049 use strict;
  1         3  
  1         35  
18 1     1   6 use parent qw( Net::API::Telegram::Generic );
  1         2  
  1         6  
19 1     1   164 our( $VERSION ) = '0.1';
20             };
21              
22 0     0 1   sub migrate_to_chat_id { return( shift->_set_get_number( 'migrate_to_chat_id', @_ ) ); }
23              
24 0     0 1   sub retry_after { return( shift->_set_get_number( 'retry_after', @_ ) ); }
25              
26             1;
27              
28             __END__
29              
30             =encoding utf-8
31              
32             =head1 NAME
33              
34             Net::API::Telegram::ResponseParameters - Information about why a request was unsuccessful
35              
36             =head1 SYNOPSIS
37              
38             my $msg = Net::API::Telegram::ResponseParameters->new( %data ) ||
39             die( Net::API::Telegram::ResponseParameters->error, "\n" );
40              
41             =head1 DESCRIPTION
42              
43             L<Net::API::Telegram::ResponseParameters> is a Telegram Message Object as defined here L<https://core.telegram.org/bots/api#responseparameters>
44              
45             This module has been automatically generated from Telegram API documentation by the script scripts/telegram-doc2perl-methods.pl.
46              
47             =head1 METHODS
48              
49             =over 4
50              
51             =item B<new>( {INIT HASH REF}, %PARAMETERS )
52              
53             B<new>() will create a new object for the package, pass any argument it might receive
54             to the special standard routine B<init> that I<must> exist.
55             Then it returns what returns B<init>().
56              
57             The valid parameters are as follow. Methods available here are also parameters to the B<new> method.
58              
59             =over 8
60              
61             =item * I<verbose>
62              
63             =item * I<debug>
64              
65             =back
66              
67             =item B<migrate_to_chat_id>( Integer )
68              
69             Optional. The group has been migrated to a supergroup with the specified identifier. This number may be greater than 32 bits and some programming languages may have difficulty/silent defects in interpreting it. But it is smaller than 52 bits, so a signed 64 bit integer or double-precision float type are safe for storing this identifier.
70              
71             =item B<retry_after>( Integer )
72              
73             Optional. In case of exceeding flood control, the number of seconds left to wait before the request can be repeated
74              
75             =back
76              
77             =head1 COPYRIGHT
78              
79             Copyright (c) 2000-2019 DEGUEST Pte. Ltd.
80              
81             =head1 AUTHOR
82              
83             Jacques Deguest E<lt>F<jack@deguest.jp>E<gt>
84              
85             =head1 SEE ALSO
86              
87             L<Net::API::Telegram>
88              
89             =head1 COPYRIGHT & LICENSE
90              
91             Copyright (c) 2018-2019 DEGUEST Pte. Ltd.
92              
93             You can use, copy, modify and redistribute this package and associated
94             files under the same terms as Perl itself.
95              
96             =cut
97