Frank Seitz
and 1 contributors

NAME

Prty::Confluence::Page - Confluence-Wiki Seite

BASE CLASS

Prty::Hash

DESCRIPTION

Ein Objekt der Klasse kapselt den Body der HTTP Antwort einer getPage()-Operation des Confluence-Client (Klasse Prty::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);

Description

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

Arguments

$json

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

Returns

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

Hash-Zugriff

hash() - Hash der JSON-Struktur

Synopsis

    $h = $pag->hash;

Description

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

Returns

Space (String)

Akzessoren

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

Synopsis

    $space = $pag->space;

Description

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

Returns

Space (String)

title() - Titel der Seite

Synopsis

    $title = $pag->title;

Description

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

Returns

Seitentitel (String)

version() - Version der Seite

Synopsis

    $n = $pag->version;

Description

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

Returns

Versionsnummer (Integer)

Debugging

asString() - Perl-Repräsentation als Zeichenkette

Synopsis

    $str = $pag->asString;

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.

Returns

Perl-Datenstruktur (als Text)

VERSION

1.108

AUTHOR

Frank Seitz, http://fseitz.de/

COPYRIGHT

Copyright (C) 2017 Frank Seitz

LICENSE

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