Google API Common Protos Client - Class Page (4.8.2)

Reference documentation and code samples for the Google API Common Protos Client class Page.

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

Generated from protobuf message google.api.Page

Namespace

Google \ Api

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ 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: <xref uid="\\Tutorial\Java">Java</xref>.
↳ content string

The Markdown content of the page. You can use (== include {path} ==) to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page.
↳ subpages array<Google\Api\Page>

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

getName

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: <xref uid="\\Tutorial\Java">Java</xref>.

Returns
Type Description
string

setName

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: <xref uid="\\Tutorial\Java">Java</xref>.

Parameter
Name Description
var string
Returns
Type Description
$this

getContent

The Markdown content of the page. You can use (== include {path} ==) to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page.

Returns
Type Description
string

setContent

The Markdown content of the page. You can use (== include {path} ==) to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page.

Parameter
Name Description
var string
Returns
Type Description
$this

getSubpages

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

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setSubpages

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

Parameter
Name Description
var array<Google\Api\Page>
Returns
Type Description
$this