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

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

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) ⇒ ReadingPosition

Returns a new instance of ReadingPosition



2322
2323
2324
 
# File 'generated/google/apis/books_v1/classes.rb', line 2322

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) 


2289
2290
2291
 
# File 'generated/google/apis/books_v1/classes.rb', line 2289

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) 


2294
2295
2296
 
# File 'generated/google/apis/books_v1/classes.rb', line 2294

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) 


2299
2300
2301
 
# File 'generated/google/apis/books_v1/classes.rb', line 2299

def gb_text_position
  @gb_text_position
end

#kind ⇒ String

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

Returns:

  • (String) 


2304
2305
2306
 
# File 'generated/google/apis/books_v1/classes.rb', line 2304

def kind
  @kind
end

#pdf_position ⇒ String

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

Returns:

  • (String) 


2309
2310
2311
 
# File 'generated/google/apis/books_v1/classes.rb', line 2309

def pdf_position
  @pdf_position
end

#updated ⇒ DateTime

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

Returns:

  • (DateTime) 


2315
2316
2317
 
# File 'generated/google/apis/books_v1/classes.rb', line 2315

def updated
  @updated
end

#volume_id ⇒ String

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

Returns:

  • (String) 


2320
2321
2322
 
# File 'generated/google/apis/books_v1/classes.rb', line 2320

def volume_id
  @volume_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2327
2328
2329
2330
2331
2332
2333
2334
2335
 
# File 'generated/google/apis/books_v1/classes.rb', line 2327

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