---
name: "WWW::OpenSearch::Description"
section: "3pm"
platform: "linux"
package: "libwww-opensearch-perl"
version: "0.17-2"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/WWW::OpenSearch::Description"
---

# WWW::OpenSearch::Description(3pm)

Encapsulate an OpenSearch Description provided by an A9 OpenSearch compatible engine

## NAME

WWW::OpenSearch::Description - Encapsulate an OpenSearch Description provided by an A9 OpenSearch compatible engine

## SYNOPSIS

```
    use WWW::OpenSearch;

    my $url = "http://bulkfeeds.net/opensearch.xml";
    my $engine = WWW::OpenSearch->new($url);
    my $description = $engine->description;

    my $format   = $description->Format;   # or $description->format
    my $longname = $description->LongName; # or $description->longname
```

## DESCRIPTION

WWW::OpenSearch::Description is a module designed to encapsulate an OpenSearch Description provided by an A9 OpenSearch compatible engine. See http://opensearch.a9.com/spec/1.1/description/ for details.

## CONSTRUCTOR

### new( \[ $xml \] )

Constructs a new instance of WWW::OpenSearch::Description. If scalar parameter `$xml` is provided, data will be automatically loaded from it using load( `$xml` ).

## METHODS

### load( $xml )

Loads description data by parsing provided argument using XML::LibXML.

### urls( )

Return all of the urls associated with this description in an array.

### get\_best\_url( )

Attempts to retrieve the best URL associated with this description, based on the following content types (from most preferred to least preferred):

- •

  application/atom+xml

- •

  application/rss+xml

- •

  text/xml

### get\_url\_by\_type( $type )

Retrieves the first WWW::OpenSearch::URL associated with this description whose type is equal to `$type`.

## ACCESSORS

### version( )

### ns( )

### AdultContent( )

### Attribution( )

### Contact( )

### Description( )

### Developer( )

### Format( )

### InputEncoding( )

### Image( )

### Language( )

### LongName( )

### OutputEncoding( )

### Query( )

### SampleSearch( )

### ShortName( )

### SyndicationRight( )

### Tags( )

### Url( )

## AUTHOR

- •

  Tatsuhiko Miyagawa \<miyagawa@bulknews.net\>

- •

  Brian Cassidy \<bricas@cpan.org\>

## COPYRIGHT AND LICENSE

Copyright 2005-2013 by Tatsuhiko Miyagawa and Brian Cassidy

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