File Coverage

blib/lib/Paws/WorkDocs/CreateComment.pm

Criterion	Covered	Total	%
statement	6	6	100.0
branch			n/a
condition			n/a
subroutine	2	2	100.0
pod			n/a
total	8	8	100.0

line	stmt	sub	time	code
1
2				package Paws::WorkDocs::CreateComment;
3	1	1	629	use Moose;
	1		5
	1		13
4				has AuthenticationToken => (is => 'ro', isa => 'Str', traits => ['ParamInHeader'], header_name => 'Authentication' );
5				has DocumentId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'DocumentId' , required => 1);
6				has NotifyCollaborators => (is => 'ro', isa => 'Bool');
7				has ParentId => (is => 'ro', isa => 'Str');
8				has Text => (is => 'ro', isa => 'Str', required => 1);
9				has ThreadId => (is => 'ro', isa => 'Str');
10				has VersionId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'VersionId' , required => 1);
11				has Visibility => (is => 'ro', isa => 'Str');
12
13	1	1	7286	use MooseX::ClassAttribute;
	1		3
	1		12
14
15				class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateComment');
16				class_has _api_uri => (isa => 'Str', is => 'ro', default => '/api/v1/documents/{DocumentId}/versions/{VersionId}/comment');
17				class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST');
18				class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::WorkDocs::CreateCommentResponse');
19				class_has _result_key => (isa => 'Str', is => 'ro');
20				1;
21
22				### main pod documentation begin ###
23
24				=head1 NAME
25
26				Paws::WorkDocs::CreateComment - Arguments for method CreateComment on Paws::WorkDocs
27
28				=head1 DESCRIPTION
29
30				This class represents the parameters used for calling the method CreateComment on the
31				Amazon WorkDocs service. Use the attributes of this class
32				as arguments to method CreateComment.
33
34				You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateComment.
35
36				As an example:
37
38				$service_obj->CreateComment(Att1 => $value1, Att2 => $value2, ...);
39
40				Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object.
41
42				=head1 ATTRIBUTES
43
44
45				=head2 AuthenticationToken => Str
46
47				Amazon WorkDocs authentication token. This field should not be set when
48				using administrative API actions, as in accessing the API using AWS
49				credentials.
50
51
52
53				=head2 B<REQUIRED> DocumentId => Str
54
55				The ID of the document.
56
57
58
59				=head2 NotifyCollaborators => Bool
60
61				Set this parameter to TRUE to send an email out to the document
62				collaborators after the comment is created.
63
64
65
66				=head2 ParentId => Str
67
68				The ID of the parent comment.
69
70
71
72				=head2 B<REQUIRED> Text => Str
73
74				The text of the comment.
75
76
77
78				=head2 ThreadId => Str
79
80				The ID of the root comment in the thread.
81
82
83
84				=head2 B<REQUIRED> VersionId => Str
85
86				The ID of the document version.
87
88
89
90				=head2 Visibility => Str
91
92				The visibility of the comment. Options are either PRIVATE, where the
93				comment is visible only to the comment author and document owner and
94				co-owners, or PUBLIC, where the comment is visible to document owners,
95				co-owners, and contributors.
96
97				Valid values are: C<"PUBLIC">, C<"PRIVATE">
98
99
100				=head1 SEE ALSO
101
102				This class forms part of L<Paws>, documenting arguments for method CreateComment in L<Paws::WorkDocs>
103
104				=head1 BUGS and CONTRIBUTIONS
105
106				The source code is located here: https://github.com/pplu/aws-sdk-perl
107
108				Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
109
110				=cut
111