Freeside:3:Documentation:Developer/FS/pbx extension

From Freeside
Jump to: navigation, search

NAME

FS::pbx_extension - Object methods for pbx_extension records

SYNOPSIS

 use FS::pbx_extension;

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

 $error = $record->insert;

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

 $error = $record->delete;

 $error = $record->check;

DESCRIPTION

An FS::pbx_extension object represents an PBX extension. FS::pbx_extension inherits from FS::Record. The following fields are currently supported:

extensionnum
primary key
svcnum
svcnum
extension
extension
pin
pin
sip_password
sip_password
phone_name
phone_name

METHODS

new HASHREF
Creates a new extension. To add the extension 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 extension. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.

BUGS

SEE ALSO

FS::svc_pbx, FS::Record