James Bromberger > Net-Dynect-REST-0.09 > Net::Dynect::REST::Session

Download:
Net-Dynect-REST-0.09.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  2
Open  0
View/Report Bugs
Module Version: 149.   Source  

NAME ^

Net::Dynect::REST::Session - A session object for the Dynect REST API

SYNOPSIS ^

 use Net::Dynect::REST;
 my $dynect = Net::Dynect::REST->new(user_name => $user, customer_name => $customer, password => $password);
 print $dynect->session . "\n";
 print $dynect->session->api_version . "\n";
 $dynect->session->delete;

METHODS ^

Creating

Net::Dynect::REST::Session->new();

Creates a new (empty) session object. You may supply the following arguments to populate this:

response => $response
token => $token
user_name => $user
api_version => $version
uri => $uri

Attributes

user_name

This gets (or sets) the user_name that was associated with the session established - as a convenience in case you have multiple sessions open and want to track them.

token

This is the value of the Auth Token header that must be sent with each authenticated request.

api_version

This is the version of the API that satisfied the call to establish the session.

Destruction

delete

This will remove the session object

SEE ALSO ^

Net::Dynect::REST, Net::Dynect::REST::info.

AUTHOR ^

James bromberger, james@rcpt.to

COPYRIGHT AND LICENSE ^

Copyright (C) 2010 by James Bromberger

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.10.1 or, at your option, any later version of Perl 5 you may have available.

syntax highlighting: