Class: Google::Apis::ServiceuserV1::Page

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

Overview

Represents a documentation page. A page can contain subpages to represent nested documentation set structure.

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

Returns a new instance of Page



833
834
835
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 833

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

Instance Attribute Details

#content ⇒ String

The Markdown content of the page. You can use (== include path ==&# 41; to include content from a Markdown file. Corresponds to the JSON property content

Returns:

  • (String) 


825
826
827
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 825

def content
  @content
end

#name ⇒ String

The name of the page. It will be used as an identity of the page to generate URI of the page, text of the link to this page in navigation, etc. The full page name (start from the root page name to this page concatenated with .) can be used as reference to the page in your documentation. For example:

pages:
- name: Tutorial
content: (== include tutorial.md ==)
subpages:
- name: Java
content: (== include tutorial_java.md ==)

You can reference Java page using Markdown reference link syntax: Java. Corresponds to the JSON property name

Returns:

  • (String) 


818
819
820
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 818

def name
  @name
end

#subpages ⇒ Array<Google::Apis::ServiceuserV1::Page>

Subpages of this page. The order of subpages specified here will be honored in the generated docset. Corresponds to the JSON property subpages

Returns:



831
832
833
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 831

def subpages
  @subpages
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



838
839
840
841
842
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 838

def update!(**args)
  @name = args[:name] if args.key?(:name)
  @content = args[:content] if args.key?(:content)
  @subpages = args[:subpages] if args.key?(:subpages)
end