Class: Google::Apis::DriveV3::Comment
- Inherits:
-
Object
- Object
- Google::Apis::DriveV3::Comment
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- lib/google/apis/drive_v3/classes.rb,
lib/google/apis/drive_v3/representations.rb,
lib/google/apis/drive_v3/representations.rb
Overview
A comment on a file. Some resource methods (such as comments.update
) require
a commentId
. Use the comments.list
method to retrieve the ID for a comment
in a file.
Defined Under Namespace
Classes: QuotedFileContent
Instance Attribute Summary collapse
-
#anchor ⇒ String
A region of the document represented as a JSON string.
-
#author ⇒ Google::Apis::DriveV3::User
Information about a Drive user.
-
#content ⇒ String
The plain text content of the comment.
-
#created_time ⇒ DateTime
The time at which the comment was created (RFC 3339 date-time).
-
#deleted ⇒ Boolean
(also: #deleted?)
Output only.
-
#html_content ⇒ String
Output only.
-
#id ⇒ String
Output only.
-
#kind ⇒ String
Output only.
-
#modified_time ⇒ DateTime
The last time the comment or any of its replies was modified (RFC 3339 date- time).
-
#quoted_file_content ⇒ Google::Apis::DriveV3::Comment::QuotedFileContent
The file content to which the comment refers, typically within the anchor region.
-
#replies ⇒ Array<Google::Apis::DriveV3::Reply>
Output only.
-
#resolved ⇒ Boolean
(also: #resolved?)
Output only.
Instance Method Summary collapse
-
#initialize(**args) ⇒ Comment
constructor
A new instance of Comment.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ Comment
Returns a new instance of Comment.
843 844 845 |
# File 'lib/google/apis/drive_v3/classes.rb', line 843 def initialize(**args) update!(**args) end |
Instance Attribute Details
#anchor ⇒ String
A region of the document represented as a JSON string. For details on defining
anchor properties, refer to Manage comments and replies.
Corresponds to the JSON property anchor
778 779 780 |
# File 'lib/google/apis/drive_v3/classes.rb', line 778 def anchor @anchor end |
#author ⇒ Google::Apis::DriveV3::User
Information about a Drive user.
Corresponds to the JSON property author
783 784 785 |
# File 'lib/google/apis/drive_v3/classes.rb', line 783 def @author end |
#content ⇒ String
The plain text content of the comment. This field is used for setting the
content, while htmlContent
should be displayed.
Corresponds to the JSON property content
789 790 791 |
# File 'lib/google/apis/drive_v3/classes.rb', line 789 def content @content end |
#created_time ⇒ DateTime
The time at which the comment was created (RFC 3339 date-time).
Corresponds to the JSON property createdTime
794 795 796 |
# File 'lib/google/apis/drive_v3/classes.rb', line 794 def created_time @created_time end |
#deleted ⇒ Boolean Also known as: deleted?
Output only. Whether the comment has been deleted. A deleted comment has no
content.
Corresponds to the JSON property deleted
800 801 802 |
# File 'lib/google/apis/drive_v3/classes.rb', line 800 def deleted @deleted end |
#html_content ⇒ String
Output only. The content of the comment with HTML formatting.
Corresponds to the JSON property htmlContent
806 807 808 |
# File 'lib/google/apis/drive_v3/classes.rb', line 806 def html_content @html_content end |
#id ⇒ String
Output only. The ID of the comment.
Corresponds to the JSON property id
811 812 813 |
# File 'lib/google/apis/drive_v3/classes.rb', line 811 def id @id end |
#kind ⇒ String
Output only. Identifies what kind of resource this is. Value: the fixed string
"drive#comment"
.
Corresponds to the JSON property kind
817 818 819 |
# File 'lib/google/apis/drive_v3/classes.rb', line 817 def kind @kind end |
#modified_time ⇒ DateTime
The last time the comment or any of its replies was modified (RFC 3339 date-
time).
Corresponds to the JSON property modifiedTime
823 824 825 |
# File 'lib/google/apis/drive_v3/classes.rb', line 823 def modified_time @modified_time end |
#quoted_file_content ⇒ Google::Apis::DriveV3::Comment::QuotedFileContent
The file content to which the comment refers, typically within the anchor
region. For a text file, for example, this would be the text at the location
of the comment.
Corresponds to the JSON property quotedFileContent
830 831 832 |
# File 'lib/google/apis/drive_v3/classes.rb', line 830 def quoted_file_content @quoted_file_content end |
#replies ⇒ Array<Google::Apis::DriveV3::Reply>
Output only. The full list of replies to the comment in chronological order.
Corresponds to the JSON property replies
835 836 837 |
# File 'lib/google/apis/drive_v3/classes.rb', line 835 def replies @replies end |
#resolved ⇒ Boolean Also known as: resolved?
Output only. Whether the comment has been resolved by one of its replies.
Corresponds to the JSON property resolved
840 841 842 |
# File 'lib/google/apis/drive_v3/classes.rb', line 840 def resolved @resolved end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
848 849 850 851 852 853 854 855 856 857 858 859 860 861 |
# File 'lib/google/apis/drive_v3/classes.rb', line 848 def update!(**args) @anchor = args[:anchor] if args.key?(:anchor) @author = args[:author] if args.key?(:author) @content = args[:content] if args.key?(:content) @created_time = args[:created_time] if args.key?(:created_time) @deleted = args[:deleted] if args.key?(:deleted) @html_content = args[:html_content] if args.key?(:html_content) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @modified_time = args[:modified_time] if args.key?(:modified_time) @quoted_file_content = args[:quoted_file_content] if args.key?(:quoted_file_content) @replies = args[:replies] if args.key?(:replies) @resolved = args[:resolved] if args.key?(:resolved) end |