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

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

Dependencies

Annotate this POD

View/Report Bugs
Source  

NAME ^

Mail::Karmasphere::Response - Karmasphere Response Object

SYNOPSIS ^

        See Mail::Karmasphere::Client

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.

METHODS ^

$response->facts()

Returns a list of fact data.

$response->combination($name)

Returns the named combination as a hash reference.

$response->value($name)

Returns the value of the named combination.

If no combiner name is given, this method looks for a combination called 'default', if present, otherwise searches for the first available combination with a value.

If $name is given, this is equivalent (but preferable) to $response->combination($name)->{v}.

$response->data($name)

Returns the data of the named combination.

The rules for choosing a combination are the same as those for $response->value($name).

$response->id()

Returns the id of this response. It will match the id passed in the query, which was either specified by the user or generated by the client.

$response->time()

Returns the time in milliseconds taken by this request.

BUGS ^

This document is incomplete.

SEE ALSO ^

Mail::Karmasphere::Client Mail::Karmasphere::Query 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: