.\" -*- 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::Command 3pm"
.TH Net::EPP::Frame::Command 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::Command \- an instance of Net::EPP::Frame for client commands
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This module is a base class for the Net::EPP::Frame::* subclasses, you should
never need to access it directly.
.SH "OBJECT HIERARCHY"
.IX Header "OBJECT HIERARCHY"
.Vb 4
\&    L<XML::LibXML::Node>
\&    +\-\-\-\-L<XML::LibXML::Document>
\&        +\-\-\-\-L<Net::EPP::Frame>
\&            +\-\-\-\-L<Net::EPP::Frame::Command>
.Ve
.SH METHODS
.IX Header "METHODS"
.Vb 1
\&        my $object = $frame\->addObject(@spec);
.Ve
.PP
This method creates and returns a new element corresponding to the data in
\&\f(CW@spec\fR, and appends it to the "command" element (as returned by the
\&\f(CWgetCommandType()\fR method below).
.PP
The Net::EPP::Frame::ObjectSpec module can be used to quickly retrieve EPP
object specifications.
.PP
.Vb 1
\&        my $type = $frame\->getCommandType;
.Ve
.PP
This method returns a scalar containing the command type (eg 'create').
.PP
.Vb 1
\&        my $type = $frame\->getCommandNode;
.Ve
.PP
This method returns the XML::LibXML::Element object corresponding to the
command in question, eg the \f(CW\*(C`<create>\*(C'\fR element (for a
Net::EPP::Frame::Command::Create object). It is within this element that
EPP objects are placed.
.PP
.Vb 1
\&        my $node = $frame\->command;
.Ve
.PP
This method returns the XML::LibXML::Element object corresponding to the
\&\f(CW\*(C`<command>\*(C'\fR element.
.PP
.Vb 1
\&        my $node = $frame\->clTRID;
.Ve
.PP
This method returns the XML::LibXML::Element object corresponding to the
\&\f(CW\*(C`<clTRID>\*(C'\fR element.
.PP
.Vb 1
\&    my $extension = $frame\->extension;
.Ve
.PP
This method returns the XML::LibXML::Element object corresponding to the
\&\f(CW\*(C`<extension>\*(C'\fR element. If one does not exist, it will be created and
inserted at the correct position.
.PP
.Vb 1
\&    my $element = $frame\->createExtensionElementFor($xmlns);
.Ve
.PP
This methods creates a new element in the \f(CW\*(C`<extension>\*(C'\fR element for the
EPP extension specified by \f(CW$xmlns\fR which can be obtained from
Net::EPP::Frame::ObjectSpec. The element's tag name will correspond to the
command name (\f(CW\*(C`create\*(C'\fR, \f(CW\*(C`update\*(C'\fR etc).
.PP
.Vb 1
\&    Example usage:
\&
\&    my $frame = Net::EPP::Frame::Command::Info::Domain\->new;
\&
\&    my $element = $frame\->createExtensionElementFor(
\&        Net::EPP::Frame::ObjectSpec\->xmlns(\*(Aqfoobar\*(Aq)
\&    );
\&
\&    // prints <info xmlns="namespace:for:foobar"/>
\&    print $element\->toString();
.Ve