Class: Google::Apis::DriveV2::Comment

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/drive_v2/classes.rb,
lib/google/apis/drive_v2/representations.rb,
lib/google/apis/drive_v2/representations.rb

Overview

A comment on a file in Google Drive. 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: Context

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Comment

Returns a new instance of Comment.



1127
1128
1129
 
# File 'lib/google/apis/drive_v2/classes.rb', line 1127

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 Add comments and replies. Corresponds to the JSON property anchor

Returns:

  • (String) 


1049
1050
1051
 
# File 'lib/google/apis/drive_v2/classes.rb', line 1049

def anchor
  @anchor
end

#author ⇒ Google::Apis::DriveV2::User

Information about a Drive user. Corresponds to the JSON property author

Returns:



1054
1055
1056
 
# File 'lib/google/apis/drive_v2/classes.rb', line 1054

def author
  @author
end

#comment_id ⇒ String

Output only. The ID of the comment. Corresponds to the JSON property commentId

Returns:

  • (String) 


1059
1060
1061
 
# File 'lib/google/apis/drive_v2/classes.rb', line 1059

def comment_id
  @comment_id
end

#content ⇒ String

The plain text content used to create this comment. This is not HTML safe and should only be used as a starting point to make edits to a comment's content. Corresponds to the JSON property content

Returns:

  • (String) 


1065
1066
1067
 
# File 'lib/google/apis/drive_v2/classes.rb', line 1065

def content
  @content
end

#context ⇒ Google::Apis::DriveV2::Comment::Context

The context of the file which is being commented on. Corresponds to the JSON property context

Returns:



1070
1071
1072
 
# File 'lib/google/apis/drive_v2/classes.rb', line 1070

def context
  @context
end

#created_date ⇒ DateTime

The date when this comment was first created. Corresponds to the JSON property createdDate

Returns:

  • (DateTime) 


1075
1076
1077
 
# File 'lib/google/apis/drive_v2/classes.rb', line 1075

def created_date
  @created_date
end

#deleted ⇒ Boolean Also known as: deleted?

Output only. Whether this comment has been deleted. If a comment has been deleted the content will be cleared and this will only represent a comment that once existed. Corresponds to the JSON property deleted

Returns:

  • (Boolean) 


1082
1083
1084
 
# File 'lib/google/apis/drive_v2/classes.rb', line 1082

def deleted
  @deleted
end

#file_id ⇒ String

Output only. The file which this comment is addressing. Corresponds to the JSON property fileId

Returns:

  • (String) 


1088
1089
1090
 
# File 'lib/google/apis/drive_v2/classes.rb', line 1088

def file_id
  @file_id
end

#file_title ⇒ String

Output only. The title of the file which this comment is addressing. Corresponds to the JSON property fileTitle

Returns:

  • (String) 


1093
1094
1095
 
# File 'lib/google/apis/drive_v2/classes.rb', line 1093

def file_title
  @file_title
end

#html_content ⇒ String

Output only. HTML formatted content for this comment. Corresponds to the JSON property htmlContent

Returns:

  • (String) 


1098
1099
1100
 
# File 'lib/google/apis/drive_v2/classes.rb', line 1098

def html_content
  @html_content
end

#kind ⇒ String

Output only. This is always drive#comment. Corresponds to the JSON property kind

Returns:

  • (String) 


1103
1104
1105
 
# File 'lib/google/apis/drive_v2/classes.rb', line 1103

def kind
  @kind
end

#modified_date ⇒ DateTime

The date when this comment or any of its replies were last modified. Corresponds to the JSON property modifiedDate

Returns:

  • (DateTime) 


1108
1109
1110
 
# File 'lib/google/apis/drive_v2/classes.rb', line 1108

def modified_date
  @modified_date
end

#replies ⇒ Array<Google::Apis::DriveV2::CommentReply>

Output only. Replies to this post. Corresponds to the JSON property replies

Returns:



1113
1114
1115
 
# File 'lib/google/apis/drive_v2/classes.rb', line 1113

def replies
  @replies
end

#self_link ⇒ String

Output only. A link back to this comment. Corresponds to the JSON property selfLink

Returns:

  • (String) 


1118
1119
1120
 
# File 'lib/google/apis/drive_v2/classes.rb', line 1118

def self_link
  @self_link
end

#status ⇒ String

Output only. The status of this comment. Status can be changed by posting a reply to a comment with the desired status. * open - The comment is still open. * resolved - The comment has been resolved by one of its replies. Corresponds to the JSON property status

Returns:

  • (String) 


1125
1126
1127
 
# File 'lib/google/apis/drive_v2/classes.rb', line 1125

def status
  @status
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
 
# File 'lib/google/apis/drive_v2/classes.rb', line 1132

def update!(**args)
  @anchor = args[:anchor] if args.key?(:anchor)
  @author = args[:author] if args.key?(:author)
  @comment_id = args[:comment_id] if args.key?(:comment_id)
  @content = args[:content] if args.key?(:content)
  @context = args[:context] if args.key?(:context)
  @created_date = args[:created_date] if args.key?(:created_date)
  @deleted = args[:deleted] if args.key?(:deleted)
  @file_id = args[:file_id] if args.key?(:file_id)
  @file_title = args[:file_title] if args.key?(:file_title)
  @html_content = args[:html_content] if args.key?(:html_content)
  @kind = args[:kind] if args.key?(:kind)
  @modified_date = args[:modified_date] if args.key?(:modified_date)
  @replies = args[:replies] if args.key?(:replies)
  @self_link = args[:self_link] if args.key?(:self_link)
  @status = args[:status] if args.key?(:status)
end