Shevek > Mail-Karmasphere-Client-2.18 > Mail::Karmasphere::Query

Download:
Mail-Karmasphere-Client-2.18.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Source  

NAME ^

Mail::Karmasphere::Query - Karmasphere Query Object

SYNOPSIS ^

        my $query = new Mail::Karmasphere::Query(...);

DESCRIPTION ^

The Perl Karma Client API consists of three objects: The Query, the Response and the Client. The user constructs a Query and passes it to a Client, which returns a Response. See Mail::Karmasphere::Client for more information.

CONSTRUCTOR ^

The class method new(...) constructs a new Query object. All arguments are optional. The following parameters are recognised as arguments to new():

Identities

A listref of identities, each of which is an [ identity, type ] pair.

Composites

A listref of composite keynames.

Composite

A single composite keyname.

Flags

The query flags.

Id

The id of this query, returned in the response. The id is autogenerated in a new query if not provided, and may be retrieved using $query->id.

Feeds

A listref of feed ids.

Combiners

A listref of combiner names.

Combiner

A single combiner name.

METHODS ^

PRIMARY METHODS

These methods are the ones you must understand in order to use Mail::Karmashere::Client.

$query->identity($data, $type, @tags)

Adds an identity to this query.

$query->composite(@composites)

Adds one or more composites to this query.

$query->flags($flags)

Sets or returns the flags of this query.

OTHER METHODS

These methods permit more flexibility and access to more features.

$query->id([$id])

Sets or returns the id of this query. If the query has no id, an id will be generated by the client and will appear in the response.

$query->identities(@identities)

Sets or returns the identities of this query.

$query->composites(@composites)

Sets or returns the composites of this query.

$query->feeds(@feeds)

Sets or returns the feeds of this query.

$query->feeds(@feeds)

Adds a feed to this query.

$query->combiners(@combiners)

Sets or returns the combiners of this query.

$query->combiner(@combiners)

Adds combiners to this query.

BUGS ^

This document is incomplete.

SEE ALSO ^

Mail::Karmasphere::Client Mail::Karmasphere::Response http://www.karmasphere.com/

COPYRIGHT ^

Copyright (c) 2005 Shevek, Karmasphere. All rights reserved.

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

syntax highlighting: