noble (3) Net::EPP::Frame::ObjectSpec.3pm.gz

NAME

       Net::EPP::Frame::ObjectSpec - metadata about EPP object types

SYNOPSIS

               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('domain');

               # create an object:
               my $domain = $check->addObject(@spec);

               # set the attributes:
               my $name = $check->createElement('domain:name');
               $name->addText('example.tld');

               # assemble the frame:
               $domain->appendChild($name);
               $check->getCommandNode->appendChild($domain);

               print $check->toString;

DESCRIPTION

       Net::EPP::Frame::ObjectSpec is a simple module designed to provide easy access to metadata for the object
       types defined in the EPP specification.

USAGE

               my @spec = Net::EPP::Frame::ObjectSpec->spec($type);

       This function returns an array containing metadata for the given object type.  If no metadata is
       registered then the function returns undef.

       The array contains three members:

               @spec = (
                       $type,
                       $xmlns,
                       $schemaLocation,
               );

       $type is the same as the supplied argument, and the other two members correspond to the XML attributes
       used to specify the object in an EPP "<command>" or "<response>" frame.

       The objects currently registered are:

       •   "domain", for domain names;

       •   "host", for DNS server hosts;

       •   "contact", for contact objects;

       •   "secDNS", for DNSSEC information;

       •   "rgp", for registry grace periods.

       Note that "secDNS" and "rgp" refer to extensions to the domain object rather than objects in their own
       right.