Class: Google::Apis::DocsV1::Location

Inherits:

Object

• Object
• Google::Apis::DocsV1::Location

Includes:

Core::Hashable, Core::JsonObjectSupport

Defined in:

generated/google/apis/docs_v1/classes.rb,
generated/google/apis/docs_v1/representations.rb,
generated/google/apis/docs_v1/representations.rb more...

Overview

A particular location in the document.

Instance Attribute Summary

• #index ⇒ Fixnum

  The zero-based index, in UTF-16 code units.

• #segment_id ⇒ String

  The ID of the header, footer or footnote the location is in.

Instance Method Summary

• #initialize(**args) ⇒ Location constructor

  A new instance of Location.

• #update!(**args) ⇒ Object

  Update properties of this object.

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Location

Returns a new instance of Location

# File 'generated/google/apis/docs_v1/classes.rb', line 2243

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

Instance Attribute Details

#index ⇒ Fixnum

The zero-based index, in UTF-16 code units. The index is relative to the beginning of the segment specified by segment_id. Corresponds to the JSON property index

Returns:

• (Fixnum)

# File 'generated/google/apis/docs_v1/classes.rb', line 2235

def index
  @index
end

#segment_id ⇒ String

The ID of the header, footer or footnote the location is in. An empty segment ID signifies the document's body. Corresponds to the JSON property segmentId

Returns:

• (String)

# File 'generated/google/apis/docs_v1/classes.rb', line 2241

def segment_id
  @segment_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

# File 'generated/google/apis/docs_v1/classes.rb', line 2248

def update!(**args)
  @index = args[:index] if args.key?(:index)
  @segment_id = args[:segment_id] if args.key?(:segment_id)
end