Difference between revisions of "Freeside:3:Documentation:Developer/FS/pbx device"

Latest revision as of 06:34, 24 March 2015

NAME

FS::pbx_device - Object methods for pbx_device records

SYNOPSIS

 use FS::pbx_device;

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

 $error = $record->insert;

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

 $error = $record->delete;

 $error = $record->check;

DESCRIPTION

An FS::pbx_device object represents a specific customer phone device, such as a SIP phone or ATA. FS::pbx_device inherits from FS::Record. The following fields are currently supported:

devicenum

primary key

devicepart

devicepart

svcnum

svcnum

mac_addr

mac_addr

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::Record