.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "OpenFrame::Response 3" .TH OpenFrame::Response 3 "2020-01-30" "perl v5.30.1" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" OpenFrame::Response \- An abstract response class .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 7 \& use OpenFrame; \& use OpenFrame::Constants; \& my $r = OpenFrame::Response\->new(); \& $r\->message("Hello world!"); \& $r\->mimetype(\*(Aqtext/html\*(Aq); \& $r\->code(ofOK); \& $r\->cookies(OpenFrame::Cookies\->new()); .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" \&\f(CW\*(C`OpenFrame::Response\*(C'\fR represents responses inside OpenFrame. Responses represent some kind of response following a request for information. .PP This module abstracts the way clients can respond with data from OpenFrame. .SH "METHODS" .IX Header "METHODS" .SS "\fBnew()\fP" .IX Subsection "new()" This method creates a new \f(CW\*(C`OpenFrame::Response\*(C'\fR object. It takes no parameters. .SS "\fBcookies()\fP" .IX Subsection "cookies()" This method gets and sets the \f(CW\*(C`OpenFrame::Cookietin\*(C'\fR that is associated with this response. .PP .Vb 2 \& my $cookietin = $r\->cookies(); \& $r\->cookies(OpenFrame::Cookies\->new()); .Ve .SS "\fBmessage()\fP" .IX Subsection "message()" This method gets and sets the message string associated with this response. A scalar reference can be stored. It will always be returned as a scalar. .PP .Vb 2 \& my $message = $r\->message(); \& $r\->message("Hello world!"); .Ve .SS "\fBcode()\fP" .IX Subsection "code()" This method gets and sets the message code associated with this response. The following message codes are exported when you use \&\f(CW\*(C`OpenFrame::Constants\*(C'\fR: ofOK, ofERROR, ofREDIRECT, ofDECLINE. .PP .Vb 2 \& my $code = $r\->code(); \& $r\->code(ofOK); .Ve .SS "\fBmimetype()\fP" .IX Subsection "mimetype()" This method gets and sets the \s-1MIME\s0 type associated with this response. .PP .Vb 2 \& my $type = $r\->mimetype(); \& $r\->mimetype(\*(Aqtext/html\*(Aq); .Ve .SH "AUTHOR" .IX Header "AUTHOR" James Duncan