Difference between revisions of "Freeside:3:Documentation:Developer/FS/clientapi session"

Revision as of 20:03, 27 June 2012

NAME

FS::clientapi_session - Object methods for clientapi_session records

SYNOPSIS

 use FS::clientapi_session;

 $record = new FS::clientapi_session \%hash;
 $record = new FS::clientapi_session { 'column' => 'value' };

 $error = $record->insert;

 $error = $new_record->replace($old_record);

 $error = $record->delete;

 $error = $record->check;

DESCRIPTION

An FS::clientapi_session object represents an FS::ClientAPI session. FS::clientapi_session inherits from FS::Record. The following fields are currently supported:

sessionnum - primary key; sessionid - session ID; namespace - session namespace

METHODS

new HASHREF

Creates a new record. To add the record to the database, see "insert".

Note that this stores the hash reference, not a distinct copy of the hash it points to. You can ask the object for a copy with the hash method.

insert

Adds this record to the database. If there is an error, returns the error, otherwise returns false.

delete

Delete this record from the database.

replace OLD_RECORD

Replaces the OLD_RECORD with this one in the database. If there is an error, returns the error, otherwise returns false.

check

Checks all fields to make sure this is a valid record. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.

BUGS

SEE ALSO

FS::ClientAPI, <FS::Record>, schema.html from the base documentation.