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



2240
2241
2242
 
# File 'generated/google/apis/books_v1/classes.rb', line 2240

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) 


2207
2208
2209
 
# File 'generated/google/apis/books_v1/classes.rb', line 2207

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) 


2212
2213
2214
 
# File 'generated/google/apis/books_v1/classes.rb', line 2212

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) 


2217
2218
2219
 
# File 'generated/google/apis/books_v1/classes.rb', line 2217

def gb_text_position
  @gb_text_position
end

#kind ⇒ String

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

Returns:

  • (String) 


2222
2223
2224
 
# File 'generated/google/apis/books_v1/classes.rb', line 2222

def kind
  @kind
end

#pdf_position ⇒ String

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

Returns:

  • (String) 


2227
2228
2229
 
# File 'generated/google/apis/books_v1/classes.rb', line 2227

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) 


2233
2234
2235
 
# File 'generated/google/apis/books_v1/classes.rb', line 2233

def updated
  @updated
end

#volume_id ⇒ String

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

Returns:

  • (String) 


2238
2239
2240
 
# File 'generated/google/apis/books_v1/classes.rb', line 2238

def volume_id
  @volume_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2245
2246
2247
2248
2249
2250
2251
2252
2253
 
# File 'generated/google/apis/books_v1/classes.rb', line 2245

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