.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35)
.\"
.\" 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 "JSON::Hyper::Link 3pm"
.TH JSON::Hyper::Link 3pm "2020-01-14" "perl v5.30.0" "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"
JSON::Hyper::Link \- represents a link found in a JSON document
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This is a tiny object representng a hyperlink found in a \s-1JSON\s0 document.
You totally have my permission to treat it as a hashref if you want.
Encapsulation, ensmapulation!
.SS "Constructor"
.IX Subsection "Constructor"
Generally speaking you don't want to construct these. They're constructed
by JSON::Hyper's \f(CW\*(C`find_links\*(C'\fR method and I can't think of any conceivable
reason why you'd want to construct one yourself. Nevertheless...
.ie n .IP """new(\e%attrs)""" 4
.el .IP "\f(CWnew(\e%attrs)\fR" 4
.IX Item "new(%attrs)"
.PD 0
.ie n .IP """new($uri)""" 4
.el .IP "\f(CWnew($uri)\fR" 4
.IX Item "new($uri)"
.PD
Constructor takes a hashref of attributes, or a single \s-1URI\s0 as a string.
.SS "Attributes"
.IX Subsection "Attributes"
These attributes are hash keys for the constructor, and also exist as
methods that can be called on the object to retrieve the value.
.ie n .IP """href""" 4
.el .IP "\f(CWhref\fR" 4
.IX Item "href"
The \s-1URL\s0 linked to.
.ie n .IP """rel""" 4
.el .IP "\f(CWrel\fR" 4
.IX Item "rel"
The relationship between the \s-1URL\s0 has with the document that linked to it.
.ie n .IP """targetSchema""" 4
.el .IP "\f(CWtargetSchema\fR" 4
.IX Item "targetSchema"
A \s-1JSON\s0 schema (see JSON::Schema) that the \s-1URL\s0 linked to supposedly
conforms to.
.Sp
A method \f(CW\*(C`target_schema\*(C'\fR is also available if you're alergic to camelCase,
but \f(CW\*(C`targetSchema\*(C'\fR is the only attribute recognised by the constructor.
.ie n .IP """method""" 4
.el .IP "\f(CWmethod\fR" 4
.IX Item "method"
The \s-1HTTP\s0 method recommended for interacting with the \s-1URL.\s0 If undef, then
\&'\s-1GET\s0' is usually a good bet.
.ie n .IP """enctype""" 4
.el .IP "\f(CWenctype\fR" 4
.IX Item "enctype"
If POSTing data to this \s-1URL,\s0 the recommended Content-Type header.
.ie n .IP """schema""" 4
.el .IP "\f(CWschema\fR" 4
.IX Item "schema"
.PD 0
.ie n .IP """properties""" 4
.el .IP "\f(CWproperties\fR" 4
.IX Item "properties"
.PD
.SH "BUGS"
.IX Header "BUGS"
Please report any bugs to <http://rt.cpan.org/>.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Related modules: JSON::Hyper.
.SH "AUTHOR"
.IX Header "AUTHOR"
Toby Inkster <tobyink@cpan.org>.
.SH "COPYRIGHT AND LICENCE"
.IX Header "COPYRIGHT AND LICENCE"
Copyright 2010\-2012 Toby Inkster.
.PP
This module is tri-licensed. It is available under the X11 (a.k.a. \s-1MIT\s0)
licence; you can also redistribute it and/or modify it under the same
terms as Perl itself.
.ie n .SS "a.k.a. ""The \s-1MIT\s0 Licence"""
.el .SS "a.k.a. ``The \s-1MIT\s0 Licence''"
.IX Subsection "a.k.a. The MIT Licence"
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the \*(L"Software\*(R"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
.PP
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
.PP
\&\s-1THE SOFTWARE IS PROVIDED \*(L"AS IS\*(R", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.\s0