Freeside:1.9:Documentation:Developer/FS/clientapi session field
From Freeside
Contents
NAME
FS::clientapi_session_field - Object methods for clientapi_session_field records
SYNOPSIS
use FS::clientapi_session_field; $record = new FS::clientapi_session_field \%hash; $record = new FS::clientapi_session_field { 'column' => 'value' }; $error = $record->insert; $error = $new_record->replace($old_record); $error = $record->delete; $error = $record->check;
DESCRIPTION
An FS::clientapi_session_field object represents a FS::ClientAPI session data field. FS::clientapi_session_field inherits from FS::Record. The following fields are currently supported:
- fieldnum - primary key; sessionnum - Base ClientAPI sesison (see FS::clientapi_session); fieldname; fieldvalie
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
The author forgot to customize this manpage.
SEE ALSO
FS::clientapi_session, FS::ClientAPI, FS::Record, schema.html from the base documentation.