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

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

Overview

A particular location in the document.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Location

Returns a new instance of Location.



2978
2979
2980
 
# File 'lib/google/apis/docs_v1/classes.rb', line 2978

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) 


2960
2961
2962
 
# File 'lib/google/apis/docs_v1/classes.rb', line 2960

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) 


2966
2967
2968
 
# File 'lib/google/apis/docs_v1/classes.rb', line 2966

def segment_id
  @segment_id
end

#tab_id ⇒ String

The tab that the location is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. Corresponds to the JSON property tabId

Returns:

  • (String) 


2976
2977
2978
 
# File 'lib/google/apis/docs_v1/classes.rb', line 2976

def tab_id
  @tab_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2983
2984
2985
2986
2987
 
# File 'lib/google/apis/docs_v1/classes.rb', line 2983

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