Christopher J. Madsen > WebService-NFSN-1.02 > WebService::NFSN::Site

Download:
WebService-NFSN-1.02.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 1.00   Source   Latest Release: WebService-NFSN-1.03

NAME ^

WebService::NFSN::Site - Access NFSN site API

VERSION ^

This document describes version 1.00 of WebService::NFSN::Site, released December 21, 2011 as part of WebService-NFSN version 1.02.

SYNOPSIS ^

    use WebService::NFSN;

    my $nfsn = WebService::NFSN->new($USER, $API_KEY);
    my $site = $nfsn->site($SHORT_NAME);
    $site->addAlias(alias => 'www.example.com');

DESCRIPTION ^

WebService::NFSN::Site provides access to NearlyFreeSpeech.NET's site API. It is only useful to people who have websites hosted at NearlyFreeSpeech.NET.

INTERFACE ^

$site = $nfsn->site($SHORT_NAME)

This constructs a new Site object for the specified $SHORT_NAME. Equivalent to $site = WebService::NFSN::Site->new($nfsn, $SHORT_NAME).

Properties

None.

Methods

$site->addAlias(alias => $ALIAS)

This adds an alias (such as "www.example.com") to an existing web site. In addition to the site, you must have permission to access the domain containing the alias. If the domain is not referenced on our system, it will be added automatically.

If the domain exists and has DNS managed by NFSN, the necessary resource records will be created automatically.

$site->removeAlias(alias => $ALIAS)

Removes an alias from a site. $ALIAS must be an existing alias for the site.

SEE ALSO ^

WebService::NFSN

AUTHOR ^

Christopher J. Madsen <perl AT cjmweb.net>

Please report any bugs or feature requests to <bug-WebService-NFSN AT rt.cpan.org> or through the web interface at http://rt.cpan.org/Public/Bug/Report.html?Queue=WebService-NFSN.

You can follow or contribute to WebService-NFSN's development at http://github.com/madsen/webservice-nfsn.

COPYRIGHT AND LICENSE ^

This software is copyright (c) 2011 by Christopher J. Madsen.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

DISCLAIMER OF WARRANTY ^

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENSE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

syntax highlighting: