Class: Google::Apis::DocsV1::TabProperties
- Inherits:
-
Object
- Object
- Google::Apis::DocsV1::TabProperties
- 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
Properties of a tab.
Instance Attribute Summary collapse
-
#icon_emoji ⇒ String
Optional.
-
#index ⇒ Fixnum
The zero-based index of the tab within the parent.
-
#nesting_level ⇒ Fixnum
Output only.
-
#parent_tab_id ⇒ String
Optional.
-
#tab_id ⇒ String
Output only.
-
#title ⇒ String
The user-visible name of the tab.
Instance Method Summary collapse
-
#initialize(**args) ⇒ TabProperties
constructor
A new instance of TabProperties.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ TabProperties
5656 5657 5658 |
# File 'lib/google/apis/docs_v1/classes.rb', line 5656 def initialize(**args) update!(**args) end |
Instance Attribute Details
#icon_emoji ⇒ String
Optional. The emoji icon displayed with the tab. A valid emoji icon is
represented by a non-empty Unicode string. Any set of characters that don't
represent a single emoji is invalid. If an emoji is invalid, a 400 bad request
error is returned. If this value is unset or empty, the tab will display the
default tab icon.
Corresponds to the JSON property iconEmoji
5627 5628 5629 |
# File 'lib/google/apis/docs_v1/classes.rb', line 5627 def icon_emoji @icon_emoji end |
#index ⇒ Fixnum
The zero-based index of the tab within the parent.
Corresponds to the JSON property index
5632 5633 5634 |
# File 'lib/google/apis/docs_v1/classes.rb', line 5632 def index @index end |
#nesting_level ⇒ Fixnum
Output only. The depth of the tab within the document. Root-level tabs start
at 0.
Corresponds to the JSON property nestingLevel
5638 5639 5640 |
# File 'lib/google/apis/docs_v1/classes.rb', line 5638 def nesting_level @nesting_level end |
#parent_tab_id ⇒ String
Optional. The ID of the parent tab. Empty when the current tab is a root-level
tab, which means it doesn't have any parents.
Corresponds to the JSON property parentTabId
5644 5645 5646 |
# File 'lib/google/apis/docs_v1/classes.rb', line 5644 def parent_tab_id @parent_tab_id end |
#tab_id ⇒ String
Output only. The ID of the tab. This field can't be changed.
Corresponds to the JSON property tabId
5649 5650 5651 |
# File 'lib/google/apis/docs_v1/classes.rb', line 5649 def tab_id @tab_id end |
#title ⇒ String
The user-visible name of the tab.
Corresponds to the JSON property title
5654 5655 5656 |
# File 'lib/google/apis/docs_v1/classes.rb', line 5654 def title @title end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
5661 5662 5663 5664 5665 5666 5667 5668 |
# File 'lib/google/apis/docs_v1/classes.rb', line 5661 def update!(**args) @icon_emoji = args[:icon_emoji] if args.key?(:icon_emoji) @index = args[:index] if args.key?(:index) @nesting_level = args[:nesting_level] if args.key?(:nesting_level) @parent_tab_id = args[:parent_tab_id] if args.key?(:parent_tab_id) @tab_id = args[:tab_id] if args.key?(:tab_id) @title = args[:title] if args.key?(:title) end |