Class: Google::Apis::BooksV1::ReadingPosition

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ ReadingPosition

Returns a new instance of ReadingPosition.



2384
2385
2386
 
# File 'lib/google/apis/books_v1/classes.rb', line 2384

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

Instance Attribute Details

#epub_cfi_position ⇒ String

Position in an EPUB as a CFI. Corresponds to the JSON property epubCfiPosition

Returns:

  • (String) 


2351
2352
2353
 
# File 'lib/google/apis/books_v1/classes.rb', line 2351

def epub_cfi_position
  @epub_cfi_position
end

#gb_image_position ⇒ String

Position in a volume for image-based content. Corresponds to the JSON property gbImagePosition

Returns:

  • (String) 


2356
2357
2358
 
# File 'lib/google/apis/books_v1/classes.rb', line 2356

def gb_image_position
  @gb_image_position
end

#gb_text_position ⇒ String

Position in a volume for text-based content. Corresponds to the JSON property gbTextPosition

Returns:

  • (String) 


2361
2362
2363
 
# File 'lib/google/apis/books_v1/classes.rb', line 2361

def gb_text_position
  @gb_text_position
end

#kind ⇒ String

Resource type for a reading position. Corresponds to the JSON property kind

Returns:

  • (String) 


2366
2367
2368
 
# File 'lib/google/apis/books_v1/classes.rb', line 2366

def kind
  @kind
end

#pdf_position ⇒ String

Position in a PDF file. Corresponds to the JSON property pdfPosition

Returns:

  • (String) 


2371
2372
2373
 
# File 'lib/google/apis/books_v1/classes.rb', line 2371

def pdf_position
  @pdf_position
end

#updated ⇒ String

Timestamp when this reading position was last updated (formatted UTC timestamp with millisecond resolution). Corresponds to the JSON property updated

Returns:

  • (String) 


2377
2378
2379
 
# File 'lib/google/apis/books_v1/classes.rb', line 2377

def updated
  @updated
end

#volume_id ⇒ String

Volume id associated with this reading position. Corresponds to the JSON property volumeId

Returns:

  • (String) 


2382
2383
2384
 
# File 'lib/google/apis/books_v1/classes.rb', line 2382

def volume_id
  @volume_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2389
2390
2391
2392
2393
2394
2395
2396
2397
 
# File 'lib/google/apis/books_v1/classes.rb', line 2389

def update!(**args)
  @epub_cfi_position = args[:epub_cfi_position] if args.key?(:epub_cfi_position)
  @gb_image_position = args[:gb_image_position] if args.key?(:gb_image_position)
  @gb_text_position = args[:gb_text_position] if args.key?(:gb_text_position)
  @kind = args[:kind] if args.key?(:kind)
  @pdf_position = args[:pdf_position] if args.key?(:pdf_position)
  @updated = args[:updated] if args.key?(:updated)
  @volume_id = args[:volume_id] if args.key?(:volume_id)
end