Mail::Karmasphere::Query - Karmasphere Query Object
my $query = new Mail::Karmasphere::Query(...);
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.
The class method new(...) constructs a new Query object. All arguments are optional. The following parameters are recognised as arguments to new():
A listref of identities, each of which is an [ identity, type ] pair.
A listref of composite keynames.
A single composite keyname.
The query flags.
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.
A listref of feed ids.
A listref of combiner names.
A single combiner name.
These methods are the ones you must understand in order to use Mail::Karmashere::Client.
Adds an identity to this query.
Adds one or more composites to this query.
Sets or returns the flags of this query.
These methods permit more flexibility and access to more features.
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.
Sets or returns the identities of this query.
Sets or returns the composites of this query.
Sets or returns the feeds of this query.
Adds a feed to this query.
Sets or returns the combiners of this query.
Adds combiners to this query.
This document is incomplete.
Mail::Karmasphere::Client Mail::Karmasphere::Response http://www.karmasphere.com/
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.
To install Mail::Karmasphere::Client, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Mail::Karmasphere::Client
CPAN shell
perl -MCPAN -e shell install Mail::Karmasphere::Client
For more information on module installation, please visit the detailed CPAN module installation guide.