File Coverage

blib/lib/Net/API/Telegram/InputMediaVideo.pm
Criterion Covered Total %
statement 7 16 43.7
branch n/a
condition n/a
subroutine 3 12 25.0
pod 8 8 100.0
total 18 36 50.0


line stmt bran cond sub pod time code
1             # -*- perl -*-
2             ##----------------------------------------------------------------------------
3             ## Net/API/Telegram/InputMediaVideo.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::InputMediaVideo;
15             BEGIN
16             {
17 1     1   846 use strict;
  1         2  
  1         30  
18 1     1   5 use parent qw( Net::API::Telegram::Generic );
  1         2  
  1         4  
19 1     1   257 our( $VERSION ) = '0.1';
20             };
21              
22 0     0 1   sub caption { return( shift->_set_get_scalar( 'caption', @_ ) ); }
23              
24 0     0 1   sub duration { return( shift->_set_get_number( 'duration', @_ ) ); }
25              
26 0     0 1   sub height { return( shift->_set_get_number( 'height', @_ ) ); }
27              
28 0     0 1   sub media { return( shift->_set_get_scalar( 'media', @_ ) ); }
29              
30 0     0 1   sub parse_mode { return( shift->_set_get_scalar( 'parse_mode', @_ ) ); }
31              
32 0     0 1   sub supports_streaming { return( shift->_set_get_scalar( 'supports_streaming', @_ ) ); }
33              
34 0     0 1   sub type { return( shift->_set_get_scalar( 'type', @_ ) ); }
35              
36 0     0 1   sub width { return( shift->_set_get_number( 'width', @_ ) ); }
37              
38 0     0     sub _is_boolean { return( grep( /^$_[1]$/, qw( supports_streaming ) ) ); }
39              
40             1;
41              
42             __END__
43              
44             =encoding utf-8
45              
46             =head1 NAME
47              
48             Net::API::Telegram::InputMediaVideo - A video to be sent
49              
50             =head1 SYNOPSIS
51              
52             my $msg = Net::API::Telegram::InputMediaVideo->new( %data ) ||
53             die( Net::API::Telegram::InputMediaVideo->error, "\n" );
54              
55             =head1 DESCRIPTION
56              
57             L<Net::API::Telegram::InputMediaVideo> is a Telegram Message Object as defined here L<https://core.telegram.org/bots/api#inputmediavideo>
58              
59             This module has been automatically generated from Telegram API documentation by the script scripts/telegram-doc2perl-methods.pl.
60              
61             =head1 METHODS
62              
63             =over 4
64              
65             =item B<new>( {INIT HASH REF}, %PARAMETERS )
66              
67             B<new>() will create a new object for the package, pass any argument it might receive
68             to the special standard routine B<init> that I<must> exist.
69             Then it returns what returns B<init>().
70              
71             The valid parameters are as follow. Methods available here are also parameters to the B<new> method.
72              
73             =over 8
74              
75             =item * I<verbose>
76              
77             =item * I<debug>
78              
79             =back
80              
81             =item B<caption>( String )
82              
83             Optional. Caption of the video to be sent, 0-1024 characters
84              
85             =item B<duration>( Integer )
86              
87             Optional. Video duration
88              
89             =item B<height>( Integer )
90              
91             Optional. Video height
92              
93             =item B<media>( String )
94              
95             File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass I<attach://<file_attach_name>> to upload a new one using multipart/form-data under <file_attach_name> name. More info on Sending Files »
96              
97             =item B<parse_mode>( String )
98              
99             Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption.
100              
101             =item B<supports_streaming>( Boolean )
102              
103             Optional. Pass True, if the uploaded video is suitable for streaming
104              
105             =item B<thumb>( InputFile or String )
106              
107             Optional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail‘s width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can’t be reused and can be only uploaded as a new file, so you can pass I<attach://<file_attach_name>> if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More info on Sending Files »
108              
109             =item B<type>( String )
110              
111             Type of the result, must be video
112              
113             =item B<width>( Integer )
114              
115             Optional. Video width
116              
117             =back
118              
119             =head1 COPYRIGHT
120              
121             Copyright (c) 2000-2019 DEGUEST Pte. Ltd.
122              
123             =head1 AUTHOR
124              
125             Jacques Deguest E<lt>F<jack@deguest.jp>E<gt>
126              
127             =head1 SEE ALSO
128              
129             L<Net::API::Telegram>
130              
131             =head1 COPYRIGHT & LICENSE
132              
133             Copyright (c) 2018-2019 DEGUEST Pte. Ltd.
134              
135             You can use, copy, modify and redistribute this package and associated
136             files under the same terms as Perl itself.
137              
138             =cut
139