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.

Defined Under Namespace

Classes: Context

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Comment

Returns a new instance of Comment.



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

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) 


1040
1041
1042
 
# File 'lib/google/apis/drive_v2/classes.rb', line 1040

def anchor
  @anchor
end

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

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

Returns:



1045
1046
1047
 
# File 'lib/google/apis/drive_v2/classes.rb', line 1045

def author
  @author
end

#comment_id ⇒ String

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

Returns:

  • (String) 


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

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) 


1056
1057
1058
 
# File 'lib/google/apis/drive_v2/classes.rb', line 1056

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:



1061
1062
1063
 
# File 'lib/google/apis/drive_v2/classes.rb', line 1061

def context
  @context
end

#created_date ⇒ DateTime

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

Returns:

  • (DateTime) 


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

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) 


1073
1074
1075
 
# File 'lib/google/apis/drive_v2/classes.rb', line 1073

def deleted
  @deleted
end

#file_id ⇒ String

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

Returns:

  • (String) 


1079
1080
1081
 
# File 'lib/google/apis/drive_v2/classes.rb', line 1079

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) 


1084
1085
1086
 
# File 'lib/google/apis/drive_v2/classes.rb', line 1084

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) 


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

def html_content
  @html_content
end

#kind ⇒ String

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

Returns:

  • (String) 


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

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) 


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

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:



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

def replies
  @replies
end

#self_link ⇒ String

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

Returns:

  • (String) 


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

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) 


1116
1117
1118
 
# File 'lib/google/apis/drive_v2/classes.rb', line 1116

def status
  @status
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
 
# File 'lib/google/apis/drive_v2/classes.rb', line 1123

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