Class: Google::Apis::BooksV1::VolumeAnnotation

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

Defined Under Namespace

Classes: ContentRanges

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

Returns a new instance of VolumeAnnotation.


3914
3915
3916
# File 'generated/google/apis/books_v1/classes.rb', line 3914

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

Instance Attribute Details

#annotation_data_idString

The annotation data id for this volume annotation. Corresponds to the JSON property annotationDataId

Returns:

  • (String)

3845
3846
3847
# File 'generated/google/apis/books_v1/classes.rb', line 3845

def annotation_data_id
  @annotation_data_id
end

Link to get data for this annotation. Corresponds to the JSON property annotationDataLink

Returns:

  • (String)

3850
3851
3852
# File 'generated/google/apis/books_v1/classes.rb', line 3850

def annotation_data_link
  @annotation_data_link
end

#annotation_typeString

The type of annotation this is. Corresponds to the JSON property annotationType

Returns:

  • (String)

3855
3856
3857
# File 'generated/google/apis/books_v1/classes.rb', line 3855

def annotation_type
  @annotation_type
end

#content_rangesGoogle::Apis::BooksV1::VolumeAnnotation::ContentRanges

The content ranges to identify the selected text. Corresponds to the JSON property contentRanges


3860
3861
3862
# File 'generated/google/apis/books_v1/classes.rb', line 3860

def content_ranges
  @content_ranges
end

#dataString

Data for this annotation. Corresponds to the JSON property data

Returns:

  • (String)

3865
3866
3867
# File 'generated/google/apis/books_v1/classes.rb', line 3865

def data
  @data
end

#deletedBoolean Also known as: deleted?

Indicates that this annotation is deleted. Corresponds to the JSON property deleted

Returns:

  • (Boolean)

3870
3871
3872
# File 'generated/google/apis/books_v1/classes.rb', line 3870

def deleted
  @deleted
end

#idString

Unique id of this volume annotation. Corresponds to the JSON property id

Returns:

  • (String)

3876
3877
3878
# File 'generated/google/apis/books_v1/classes.rb', line 3876

def id
  @id
end

#kindString

Resource Type Corresponds to the JSON property kind

Returns:

  • (String)

3881
3882
3883
# File 'generated/google/apis/books_v1/classes.rb', line 3881

def kind
  @kind
end

#layer_idString

The Layer this annotation is for. Corresponds to the JSON property layerId

Returns:

  • (String)

3886
3887
3888
# File 'generated/google/apis/books_v1/classes.rb', line 3886

def layer_id
  @layer_id
end

#page_idsArray<String>

Pages the annotation spans. Corresponds to the JSON property pageIds

Returns:

  • (Array<String>)

3891
3892
3893
# File 'generated/google/apis/books_v1/classes.rb', line 3891

def page_ids
  @page_ids
end

#selected_textString

Excerpt from the volume. Corresponds to the JSON property selectedText

Returns:

  • (String)

3896
3897
3898
# File 'generated/google/apis/books_v1/classes.rb', line 3896

def selected_text
  @selected_text
end

URL to this resource. Corresponds to the JSON property selfLink

Returns:

  • (String)

3901
3902
3903
# File 'generated/google/apis/books_v1/classes.rb', line 3901

def self_link
  @self_link
end

#updatedDateTime

Timestamp for the last time this anntoation was updated. (RFC 3339 UTC date- time format). Corresponds to the JSON property updated

Returns:

  • (DateTime)

3907
3908
3909
# File 'generated/google/apis/books_v1/classes.rb', line 3907

def updated
  @updated
end

#volume_idString

The Volume this annotation is for. Corresponds to the JSON property volumeId

Returns:

  • (String)

3912
3913
3914
# File 'generated/google/apis/books_v1/classes.rb', line 3912

def volume_id
  @volume_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
# File 'generated/google/apis/books_v1/classes.rb', line 3919

def update!(**args)
  @annotation_data_id = args[:annotation_data_id] if args.key?(:annotation_data_id)
  @annotation_data_link = args[:annotation_data_link] if args.key?(:annotation_data_link)
  @annotation_type = args[:annotation_type] if args.key?(:annotation_type)
  @content_ranges = args[:content_ranges] if args.key?(:content_ranges)
  @data = args[:data] if args.key?(:data)
  @deleted = args[:deleted] if args.key?(:deleted)
  @id = args[:id] if args.key?(:id)
  @kind = args[:kind] if args.key?(:kind)
  @layer_id = args[:layer_id] if args.key?(:layer_id)
  @page_ids = args[:page_ids] if args.key?(:page_ids)
  @selected_text = args[:selected_text] if args.key?(:selected_text)
  @self_link = args[:self_link] if args.key?(:self_link)
  @updated = args[:updated] if args.key?(:updated)
  @volume_id = args[:volume_id] if args.key?(:volume_id)
end