File Coverage

blib/lib/WebService/Mattermost/V4/API/Resource/WebRTC.pm

Criterion	Covered	Total	%
statement	3	5	60.0
branch			n/a
condition			n/a
subroutine	1	2	50.0
pod	1	1	100.0
total	5	8	62.5

package WebService::Mattermost::V4::API::Resource::WebRTC;
 2: 
 3: # ABSTRACT: Wrapped API methods for the WebRTC API endpoints. 4: 
 5: use Moo;
 6: 
 7: extends 'WebService::Mattermost::V4::API::Resource';
 8: 
 9: ################################################################################
10: 
11: sub get_token {
12:     my $self = shift;
13: 
14:     return $self->_single_view_get({
15:         endpoint => 'token',
16:         view     => 'WebRTCToken',
17:     });
18: }
19: 
20: ################################################################################
21: 
22: 1;
23: 
24: __END__
25: 
26: =pod
27: 
28: =encoding UTF-8
29: 
30: =head1 NAME
31: 
32: WebService::Mattermost::V4::API::Resource::WebRTC - Wrapped API methods for the WebRTC API endpoints.
33: 
34: =head1 VERSION
35: 
36: version 0.28
37: 
38: =head1 DESCRIPTION
39: 
40: B<This API endpoint was removed from Mattermost in version v5.6 (October 2018).
41: As such, the methods in this class will not do anything when used with recent
42: versions of Mattermost!>
43: 
44: =head2 USAGE
45: 
46:     use WebService::Mattermost;
47: 
48:     my $mm = WebService::Mattermost->new({
49:         authenticate => 1,
50:         username     => '[e-mail]',
51:         password     => 'hunter2',
52:         base_url     => 'https://my.mattermost.server.com/api/v4/',
53:     });
54: 
55:     my $resource = $mm->api->webrtc;
56: 
57: =head2 METHODS
58: 
59: =over 4
60: 
61: =item C<get_token()>
62: 
63: L<Get WebRTC token|https://api.mattermost.com/#tag/system%2Fpaths%2F~1webrtc~1token%2Fget>
64: 
65:     my $response = $resource->get_token();
66: 
67: =back
68: 
69: =head1 AUTHOR
70: 
71: Mike Jones <[e-mail]>
72: 
73: =head1 COPYRIGHT AND LICENSE
74: 
75: This software is Copyright (c) 2020 by Mike Jones.
76: 
77: This is free software, licensed under:
78: 
79:   The MIT (X11) License
80: 
81: =cut
82: