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

Latest revision as of 20:05, 27 June 2012

NAME

FS::phone_device - Object methods for phone_device records

SYNOPSIS

 use FS::phone_device;

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

 $error = $record->insert;

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

 $error = $record->delete;

 $error = $record->check;

DESCRIPTION

An FS::phone_device object represents a specific customer phone device, such as a SIP phone or ATA. FS::phone_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.

part_device

Returns the device type record (see FS::part_device) associated with this customer device.

svc_phone

Returns the phone number (see FS::svc_phone) associated with this customer device.

export HOOK [ EXPORT_ARGS ]

Runs the provided export hook (i.e. "device_insert") for this service.

export_links

Returns a list of html elements associated with this device's exports.

BUGS

SEE ALSO

FS::Record, schema.html from the base documentation.