File Coverage

blib/lib/Paws/WorkDocs/Comment.pm
Criterion Covered Total %
statement 3 3 100.0
branch n/a
condition n/a
subroutine 1 1 100.0
pod n/a
total 4 4 100.0


line stmt bran cond sub pod time code
1             package Paws::WorkDocs::Comment;
2 1     1   784 use Moose;
  1         3  
  1         12  
3             has CommentId => (is => 'ro', isa => 'Str', required => 1);
4             has Contributor => (is => 'ro', isa => 'Paws::WorkDocs::User');
5             has CreatedTimestamp => (is => 'ro', isa => 'Str');
6             has ParentId => (is => 'ro', isa => 'Str');
7             has RecipientId => (is => 'ro', isa => 'Str');
8             has Status => (is => 'ro', isa => 'Str');
9             has Text => (is => 'ro', isa => 'Str');
10             has ThreadId => (is => 'ro', isa => 'Str');
11             has Visibility => (is => 'ro', isa => 'Str');
12             1;
13              
14             ### main pod documentation begin ###
15              
16             =head1 NAME
17              
18             Paws::WorkDocs::Comment
19              
20             =head1 USAGE
21              
22             This class represents one of two things:
23              
24             =head3 Arguments in a call to a service
25              
26             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
27             Each attribute should be used as a named argument in the calls that expect this type of object.
28              
29             As an example, if Att1 is expected to be a Paws::WorkDocs::Comment object:
30              
31             $service_obj->Method(Att1 => { CommentId => $value, ..., Visibility => $value });
32              
33             =head3 Results returned from an API call
34              
35             Use accessors for each attribute. If Att1 is expected to be an Paws::WorkDocs::Comment object:
36              
37             $result = $service_obj->Method(...);
38             $result->Att1->CommentId
39              
40             =head1 DESCRIPTION
41              
42             Describes a comment.
43              
44             =head1 ATTRIBUTES
45              
46              
47             =head2 B<REQUIRED> CommentId => Str
48              
49             The ID of the comment.
50              
51              
52             =head2 Contributor => L<Paws::WorkDocs::User>
53              
54             The details of the user who made the comment.
55              
56              
57             =head2 CreatedTimestamp => Str
58              
59             The time that the comment was created.
60              
61              
62             =head2 ParentId => Str
63              
64             The ID of the parent comment.
65              
66              
67             =head2 RecipientId => Str
68              
69             If the comment is a reply to another user's comment, this field
70             contains the user ID of the user being replied to.
71              
72              
73             =head2 Status => Str
74              
75             The status of the comment.
76              
77              
78             =head2 Text => Str
79              
80             The text of the comment.
81              
82              
83             =head2 ThreadId => Str
84              
85             The ID of the root comment in the thread.
86              
87              
88             =head2 Visibility => Str
89              
90             The visibility of the comment. Options are either PRIVATE, where the
91             comment is visible only to the comment author and document owner and
92             co-owners, or PUBLIC, where the comment is visible to document owners,
93             co-owners, and contributors.
94              
95              
96              
97             =head1 SEE ALSO
98              
99             This class forms part of L<Paws>, describing an object used in L<Paws::WorkDocs>
100              
101             =head1 BUGS and CONTRIBUTIONS
102              
103             The source code is located here: https://github.com/pplu/aws-sdk-perl
104              
105             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
106              
107             =cut
108