view release on metacpan or  search on metacpan

docs/Footprintless-Plugin-Atlassian-Confluence-ResponseParser.html  view on Meta::CPAN

   then reconverting this document from the Pod source.
   When in doubt, email the author of Pod::Simple::HTML for advice.
   See 'perldoc Pod::Simple::HTML' for more info.

-->

<!-- start doc -->
<a name='___top' class='dummyTopAnchor' ></a>

<div class='indexgroup'>
<ul   class='indexList indexList1'>
  <li class='indexItem indexItem1'><a href='#NAME'>NAME</a>
  <li class='indexItem indexItem1'><a href='#VERSION'>VERSION</a>
  <li class='indexItem indexItem1'><a href='#SYNOPSIS'>SYNOPSIS</a>
  <li class='indexItem indexItem1'><a href='#DESCRIPTION'>DESCRIPTION</a>
  <li class='indexItem indexItem1'><a href='#CONSTRUCTORS'>CONSTRUCTORS</a>
  <ul   class='indexList indexList2'>
    <li class='indexItem indexItem2'><a href='#new()'>new()</a>
  </ul>
  <li class='indexItem indexItem1'><a href='#AUTHOR'>AUTHOR</a>
  <li class='indexItem indexItem1'><a href='#COPYRIGHT_AND_LICENSE'>COPYRIGHT AND LICENSE</a>
  <li class='indexItem indexItem1'><a href='#SEE_ALSO'>SEE ALSO</a>
</ul>
</div>

<h1><a class='u' href='#___top' title='click to go to top of document'
name="NAME"
>NAME</a></h1>

<p>Footprintless::Plugin::Atlassian::Confluence::ResponseParser - A response parser for the Atlassian Confluence REST API</p>

<h1><a class='u' href='#___top' title='click to go to top of document'
name="VERSION"
>VERSION</a></h1>

<p>version 1.03</p>

<h1><a class='u' href='#___top' title='click to go to top of document'
name="SYNOPSIS"
>SYNOPSIS</a></h1>

<pre>    my $response_parser = 
        Footprintless::Plugin::Atlassian::Confluence::ResponseParser
            -&#62;new();

    # A parse a get content response
    my $response = $response_parser-&#62;get_content($http_response);
    die(&#39;failed&#39;) unless $response-&#62;{success};</pre>

<h1><a class='u' href='#___top' title='click to go to top of document'
name="DESCRIPTION"
>DESCRIPTION</a></h1>

<p>This is the default implementation of a response parser. There is a parse method for corresponding to each build method in <a href="http://search.cpan.org/perldoc?Footprintless%3A%3APlugin%3A%3AAtlassian%3A%3AConfluence%3A%3ARequestBuilder" class=...
>Footprintless::Plugin::Atlassian::Confluence::RequestBuilder</a>, and they all parse http responses into a hasref of the form:</p>

<pre>   my $response = {
       status =&#62; 0, # truthy if $http_response-&#62;is_success()
       code =&#62; 200, # $http_response-&#62;code()
       message =&#62; &#39;Success&#39;, # $http_response-&#62;message()
       content =&#62; {} # decode_json($http_response-&#62;decoded_content())
   };</pre>

<h1><a class='u' href='#___top' title='click to go to top of document'
name="CONSTRUCTORS"
>CONSTRUCTORS</a></h1>

<h2><a class='u' href='#___top' title='click to go to top of document'
name="new()"
>new()</a></h2>

<p>Constructs a new response parser.</p>

<h1><a class='u' href='#___top' title='click to go to top of document'
name="AUTHOR"
>AUTHOR</a></h1>

<p>Lucas Theisen &#60;lucastheisen@pastdev.com&#62;</p>

<h1><a class='u' href='#___top' title='click to go to top of document'
name="COPYRIGHT_AND_LICENSE"
>COPYRIGHT AND LICENSE</a></h1>

<p>This software is copyright (c) 2016 by Lucas Theisen.</p>

<p>This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.</p>

<h1><a class='u' href='#___top' title='click to go to top of document'
name="SEE_ALSO"
>SEE ALSO</a></h1>

<p>Please see those modules/websites for more information related to this module.</p>

<ul>
<li><a href="http://search.cpan.org/perldoc?Footprintless%3A%3APlugin%3A%3AAtlassian%3A%3AConfluence" class="podlinkpod"
>Footprintless::Plugin::Atlassian::Confluence</a></li>

<li><a href="http://search.cpan.org/perldoc?Footprintless%3A%3APlugin%3A%3AAtlassian%3A%3AConfluence" class="podlinkpod"
>Footprintless::Plugin::Atlassian::Confluence</a></li>

<li><a href="http://search.cpan.org/perldoc?Footprintless%3A%3APlugin%3A%3AAtlassian%3A%3AConfluence%3A%3AClient" class="podlinkpod"
>Footprintless::Plugin::Atlassian::Confluence::Client</a></li>

<li><a href="http://search.cpan.org/perldoc?Footprintless%3A%3APlugin%3A%3AAtlassian%3A%3AConfluence%3A%3ARequestBuilder" class="podlinkpod"
>Footprintless::Plugin::Atlassian::Confluence::RequestBuilder</a></li>

<li><a href="https://docs.atlassian.com/atlassian-confluence/REST/latest-server" class="podlinkurl"
>https://docs.atlassian.com/atlassian-confluence/REST/latest-server</a></li>
</ul>

<!-- end doc -->

</body></html>