.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" 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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    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 "Net::EPP::Frame::ObjectSpec 3pm"
.TH Net::EPP::Frame::ObjectSpec 3pm 2024-04-27 "perl v5.38.2" "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
Net::EPP::Frame::ObjectSpec \- metadata about EPP objects and extensions.
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 2
\&        use Net::EPP::Frame;
\&        use strict;
\&
\&        # create an EPP frame:
\&        my $check = Net::EPP::Frame::Command::Check\->new;
\&
\&        # get the spec:
\&        my @spec = Net::EPP::Frame::ObjectSpec\->spec(\*(Aqdomain\*(Aq);
\&
\&        # create an object:
\&        my $domain = $check\->addObject(@spec);
\&
\&        # set the attributes:
\&        my $name = $check\->createElement(\*(Aqdomain:name\*(Aq);
\&        $name\->addText(\*(Aqexample.tld\*(Aq);
\&
\&        # assemble the frame:
\&        $domain\->appendChild($name);
\&        $check\->getCommandNode\->appendChild($domain);
\&
\&        print $check\->toString;
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
\&\f(CW\*(C`Net::EPP::Frame::ObjectSpec\*(C'\fR is a simple module designed to provide easy access
to metadata for the objects and extensions defined in EPP and various
extensions.
.SH METHODS
.IX Header "METHODS"
.ie n .SS xmlns()
.el .SS \f(CWxmlns()\fP
.IX Subsection "xmlns()"
.Vb 1
\&    my $xmlns = Net::EPP::Frame::ObjectSpec\->xmlns($type);
.Ve
.PP
Returns a string containing the XML namespace URI of the thing identified by
\&\f(CW$type\fR, or \f(CW\*(C`undef\*(C'\fR if \f(CW$type\fR is unknown.
.PP
See below for possible values of \f(CW$type\fR.
.ie n .SS spec()
.el .SS \f(CWspec()\fP
.IX Subsection "spec()"
.Vb 1
\&        my @spec = Net::EPP::Frame::ObjectSpec\->spec($type);
.Ve
.PP
This function returns an array containing metadata for the given object type.
If no metadata is registered then the function returns \f(CW\*(C`undef\*(C'\fR.
.PP
The returned array contains three members:
.PP
.Vb 5
\&        @spec = (
\&                $type,
\&                $xmlns,
\&                $schemaLocation, # (deprecated)
\&        );
.Ve
.PP
\&\f(CW$type\fR is the same as the supplied argument, while \f(CW$xmlns\fR is the XML
namespace URI for the given type. The third argument is suitable for inclusion
in a \f(CW\*(C`schemaLocation\*(C'\fR attribute, but is now deprecated and will be \f(CW\*(C`undef\*(C'\fR for
any value of \f(CW$type\fR other than \f(CW\*(C`domain\*(C'\fR, \f(CW\*(C`host\*(C'\fR \f(CW\*(C`contact\*(C'\fR, \f(CW\*(C`secDNS\*(C'\fR and
\&\f(CW\*(C`rgp\*(C'\fR.
.ie n .SH "THE $type ARGUMENT"
.el .SH "THE \f(CW$type\fP ARGUMENT"
.IX Header "THE $type ARGUMENT"
The \f(CW$type\fR argument to \f(CWxmlns()\fR and \f(CWspec()\fR identifies the object or
extension desired. Possible values are:
.SS "OBJECT MAPPINGS"
.IX Subsection "OBJECT MAPPINGS"
.IP \(bu 4
\&\f(CW\*(C`domain\*(C'\fR, for domain names;
.IP \(bu 4
\&\f(CW\*(C`host\*(C'\fR, for host objects;
.IP \(bu 4
\&\f(CW\*(C`contact\*(C'\fR, for contact objects;
.IP \(bu 4
\&\f(CW\*(C`org\*(C'\fR, for organization object.
.SS EXTENSIONS
.IX Subsection "EXTENSIONS"
.IP \(bu 4
\&\f(CW\*(C`secDNS\*(C'\fR, for the DNSSEC extension;
.IP \(bu 4
\&\f(CW\*(C`rgp\*(C'\fR, for Registry Grace Period extension;
.IP \(bu 4
\&\f(CW\*(C`ttl\*(C'\fR, for the TTL extension;
.IP \(bu 4
\&\f(CW\*(C`maintenance\*(C'\fR, for the Maintenance extension;
.IP \(bu 4
\&\f(CW\*(C`secure\-authinfo\-transfer\*(C'\fR, for the Secure authInfo extension;
.IP \(bu 4
\&\f(CW\*(C`b\-dn\*(C'\fR, for the bundled domain names extension;
.IP \(bu 4
\&\f(CW\*(C`unhandled\-namespaces\*(C'\fR, for the unhandled namespaces extension;
.IP \(bu 4
\&\f(CW\*(C`loginSec\*(C'\fR, for the Login Security extension;
.IP \(bu 4
\&\f(CW\*(C`fee\*(C'\fR, for the Fee extension;
.IP \(bu 4
\&\f(CW\*(C`changePoll\*(C'\fR, for the Change Poll extension;
.IP \(bu 4
\&\f(CW\*(C`orgext\*(C'\fR, for the Organization extension;
.IP \(bu 4
\&\f(CW\*(C`allocationToken\*(C'\fR, for the Allocation Token extension;
.IP \(bu 4
\&\f(CW\*(C`launch\*(C'\fR, for the Launch extension;
.IP \(bu 4
\&\f(CW\*(C`keyrelay\*(C'\fR, for the Key Relay extension;
.IP \(bu 4
\&\f(CW\*(C`ttl\*(C'\fR, for the TTL extension.
.SH COPYRIGHT
.IX Header "COPYRIGHT"
This module is (c) 2008 \- 2023 CentralNic Ltd and 2024 Gavin Brown. This module
is free software; you can redistribute it and/or modify it under the same terms
as Perl itself.