Smartswitch
Operations | List of all members
Smartswitch::Telephony::Forwarding::Number Interface Reference

This interface allows to manipulate the forwarding numbers which are bound to the Rule. More...

defined in <Number.ice>

interface Number extends Smartswitch::Destroyable { ... }

Inheritance diagram for Smartswitch::Telephony::Forwarding::Number:
Inheritance graph
[legend]
Collaboration diagram for Smartswitch::Telephony::Forwarding::Number:
Collaboration graph
[legend]

Operations

idempotent int getDialDelay ()
 Obtain a dial delay for a given forwarding number. More...
 
idempotent int getDialTimeout ()
 Obtain a dial timeout for a given forwarding number. More...
 
idempotent string getNumber ()
 Obtain a forwarding number. More...
 
idempotent int getPriority ()
 Obtain a priority for a given forwarding number. More...
 
void remove ()
 Remove a given Number. More...
 
idempotent void setDialDelay (int dialDelay) throws ArgumentException
 Set a dial delay for a given forwarding number. More...
 
idempotent void setDialTimeout (int dialTimeout) throws ArgumentException
 Set a dial timeout for a given forwarding number. More...
 
idempotent void setNumber (string number) throws EmptyArgumentException
 Set a forwarding number. More...
 
idempotent void setPriority (int priority)
 Set a priority for a given forwarding number. More...
 
- Operations inherited from Smartswitch::Destroyable
void destroy ()
 Destroy the proxy entity at the Smartswitch side. More...
 

Detailed Description

This interface allows to manipulate the forwarding numbers which are bound to the Rule.

Operation Documentation

◆ getDialDelay()

idempotent int getDialDelay ( )

Obtain a dial delay for a given forwarding number.

It indicates the amount of seconds Smartswitch will wait before dialing this number.
It's useful when you forward to several numbers and want to have a delay between them.
Using this parameter you can control the delay of dialing the forwarding numbers.

Returns
The dial delay in seconds.

◆ getDialTimeout()

idempotent int getDialTimeout ( )

Obtain a dial timeout for a given forwarding number.

It indicates the amount of seconds Smartswitch will wait before cancelling a dialing this number.
It's useful when you forward to several numbers and want to have a delay between them.
Using this parameter you can control the timeout of dialing the forwarding numbers.

Returns
The dial timeout in seconds.

◆ getNumber()

idempotent string getNumber ( )

Obtain a forwarding number.

Returns
The dialed forwarding number.

◆ getPriority()

idempotent int getPriority ( )

Obtain a priority for a given forwarding number.

It indicates the order of dialing this number among other forwarding numbers.
It's useful when you forward to several numbers and want to have a delay between them.
Using this parameter you can control the order of dialing the forwarding numbers.

Returns
The priority (the greater - the less is the priority).

◆ remove()

void remove ( )

Remove a given Number.

◆ setDialDelay()

idempotent void setDialDelay ( int  dialDelay) throws ArgumentException

Set a dial delay for a given forwarding number.

It indicates the amount of seconds Smartswitch will wait before dialing this number.
It's useful when you forward to several numbers and want to have a delay between them.
Using this parameter you can control the delay of dialing the forwarding numbers.

Parameters
dialDelayThe dial delay in seconds.

◆ setDialTimeout()

idempotent void setDialTimeout ( int  dialTimeout) throws ArgumentException

Set a dial timeout for a given forwarding number.

It indicates the amount of seconds Smartswitch will wait before cancelling a dialing this number.
It's useful when you forward to several numbers and want to have a delay between them.
Using this parameter you can control the timeout of dialing the forwarding numbers.

Parameters
dialTimeoutThe dial timeout in seconds.

◆ setNumber()

idempotent void setNumber ( string  number) throws EmptyArgumentException

Set a forwarding number.

Parameters
numberThe dialed forwarding number.

◆ setPriority()

idempotent void setPriority ( int  priority)

Set a priority for a given forwarding number.

It indicates the order of dialing this number among other forwarding numbers.
It's useful when you forward to several numbers and want to have a delay between them.
Using this parameter you can control the order of dialing the forwarding numbers.

Parameters
priorityThe priority (the greater - the less is the priority).

The documentation for this interface was generated from the following file: