Class: Google::Apis::DriveV3::Comment

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

Overview

A comment on a file.

Defined Under Namespace

Classes: QuotedFileContent

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Comment

Returns a new instance of Comment



389
390
391
 
# File 'generated/google/apis/drive_v3/classes.rb', line 389

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#anchor ⇒ String

A region of the document represented as a JSON string. See anchor documentation for details on how to define and interpret anchor properties. Corresponds to the JSON property anchor

Returns:

  • (String) 


325
326
327
 
# File 'generated/google/apis/drive_v3/classes.rb', line 325

def anchor
  @anchor
end

#author ⇒ Google::Apis::DriveV3::User

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

Returns:



330
331
332
 
# File 'generated/google/apis/drive_v3/classes.rb', line 330

def author
  @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

Returns:

  • (String) 


336
337
338
 
# File 'generated/google/apis/drive_v3/classes.rb', line 336

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

Returns:

  • (DateTime) 


341
342
343
 
# File 'generated/google/apis/drive_v3/classes.rb', line 341

def created_time
  @created_time
end

#deleted ⇒ Boolean Also known as: deleted?

Whether the comment has been deleted. A deleted comment has no content. Corresponds to the JSON property deleted

Returns:

  • (Boolean) 


346
347
348
 
# File 'generated/google/apis/drive_v3/classes.rb', line 346

def deleted
  @deleted
end

#html_content ⇒ String

The content of the comment with HTML formatting. Corresponds to the JSON property htmlContent

Returns:

  • (String) 


352
353
354
 
# File 'generated/google/apis/drive_v3/classes.rb', line 352

def html_content
  @html_content
end

#id ⇒ String

The ID of the comment. Corresponds to the JSON property id

Returns:

  • (String) 


357
358
359
 
# File 'generated/google/apis/drive_v3/classes.rb', line 357

def id
  @id
end

#kind ⇒ String

Identifies what kind of resource this is. Value: the fixed string "drive# comment". Corresponds to the JSON property kind

Returns:

  • (String) 


363
364
365
 
# File 'generated/google/apis/drive_v3/classes.rb', line 363

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

Returns:

  • (DateTime) 


369
370
371
 
# File 'generated/google/apis/drive_v3/classes.rb', line 369

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

Returns:



376
377
378
 
# File 'generated/google/apis/drive_v3/classes.rb', line 376

def quoted_file_content
  @quoted_file_content
end

#replies ⇒ Array<Google::Apis::DriveV3::Reply>

The full list of replies to the comment in chronological order. Corresponds to the JSON property replies

Returns:



381
382
383
 
# File 'generated/google/apis/drive_v3/classes.rb', line 381

def replies
  @replies
end

#resolved ⇒ Boolean Also known as: resolved?

Whether the comment has been resolved by one of its replies. Corresponds to the JSON property resolved

Returns:

  • (Boolean) 


386
387
388
 
# File 'generated/google/apis/drive_v3/classes.rb', line 386

def resolved
  @resolved
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



394
395
396
397
398
399
400
401
402
403
404
405
406
407
 
# File 'generated/google/apis/drive_v3/classes.rb', line 394

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