The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.

NAME

Quiq::Confluence::Page - Confluence-Wiki Seite

BASE CLASS

Quiq::Hash

DESCRIPTION

Ein Objekt der Klasse kapselt den Body der HTTP Antwort einer getPage()-Operation des Confluence-Client (Klasse Quiq::Confluence::Client). Mit den Methoden der Klasse kann auf die Information in der Antwort zugegriffen werden.

METHODS

Konstruktor

new() - Konstruktor

Synopsis

    $pag = $class->new($json);

Arguments

$json

Body der HTTP-Antwort der getPage()-Operation. Der Body enthält die JSON-Repräsentation der Seite.

Returns

Page-Objekt (Klasse Quiq::Confluence::Page)

Description

Instantiiere ein Confluence Seiten-Objekt und liefere eine Referenz auf dieses Objekt zurück.

Hash-Zugriff

hash() - Hash der JSON-Struktur

Synopsis

    $h = $pag->hash;

Returns

Space (String)

Description

Liefere eine Referenz auf den Hash, der der JSON-Struktur der Seite entspricht.

Akzessoren

id() - Id der Seite

Synopsis

    $id = $pag->id;

Returns

Space (integer)

Description

Liefere die Id der Seite.

space() - Name des Space, in dem die Seite liegt

Synopsis

    $space = $pag->space;

Returns

Space (String)

Description

Liefere den Namen des Space, in dem die Seite liegt.

title() - Titel der Seite

Synopsis

    $title = $pag->title;

Returns

Seitentitel (String)

Description

Liefere den Titel der Seite. Der Seitentitel ist unabhängig vom Seiteninhalt.

version() - Version der Seite

Synopsis

    $n = $pag->version;

Returns

Versionsnummer (Integer)

Description

Liefere die Version der Seite. Dies ist eine ganze Zahl > 0.

Debugging

asString() - Perl-Repräsentation als Zeichenkette

Synopsis

    $str = $pag->asString;

Returns

Perl-Datenstruktur (als Text)

Description

Der Konstruktor der Klasse wandelt die JSON-Darstellung der Seite in eine analoge Perl-Datenstruktur. Diese Methode liefert die Zeichenketten-Repäsentation dieser Perl-Datenstruktur.

VERSION

1.147

AUTHOR

Frank Seitz, http://fseitz.de/

COPYRIGHT

Copyright (C) 2019 Frank Seitz

LICENSE

This code is free software; you can redistribute it and/or modify it under the same terms as Perl itself.