This interface allows to manipulate the forwarding rules for a given User or UserGroup. More...
defined in <Rule.ice>
interface Rule extends Smartswitch::Destroyable { ... }
Operations | |
| Number * | addNumber (string number) throws EmptyArgumentException |
| Add a new Number for this rule. More... | |
| idempotent string | getCalleeIdPattern () |
| Obtain the callee ID pattern for this rule. More... | |
| idempotent string | getCallerIdPattern () |
| Obtain the caller ID pattern for this rule. More... | |
| NumberSequence | getNumbers () |
| Obtain the Number proxies for this rule. More... | |
| Timetable * | getTimetable () |
| Obtain the Timetable proxy for this rule. More... | |
| void | remove () |
| Remove a given Rule. More... | |
| idempotent void | setCalleeIdPattern (string pattern) |
| Set the callee ID pattern for this rule. More... | |
| idempotent void | setCallerIdPattern (string pattern) |
| Set the caller ID pattern for this rule. 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 rules for a given User or UserGroup.
Operation Documentation
◆ addNumber()
| Number* addNumber | ( | string | number | ) | throws EmptyArgumentException |
Add a new Number for this rule.
When a Rule is matched, Smartswitch dials the Numbers.
- Returns
- A proxy to a newly added Number which could be further configured.
◆ getCalleeIdPattern()
| idempotent string getCalleeIdPattern | ( | ) |
Obtain the callee ID pattern for this rule.
A Rule is matched when all its patterns are matched.
An empty pattern is considered a wildcard pattern.
- Returns
- The callee ID pattern.
◆ getCallerIdPattern()
| idempotent string getCallerIdPattern | ( | ) |
Obtain the caller ID pattern for this rule.
A Rule is matched when all its patterns are matched.
An empty pattern is considered a wildcard pattern.
- Returns
- The caller ID pattern.
◆ getNumbers()
| NumberSequence getNumbers | ( | ) |
Obtain the Number proxies for this rule.
When a Rule is matched, Smartswitch dials the numbers.
- Returns
- The list of Number.
◆ getTimetable()
| Timetable* getTimetable | ( | ) |
◆ remove()
| void remove | ( | ) |
Remove a given Rule.
◆ setCalleeIdPattern()
| idempotent void setCalleeIdPattern | ( | string | pattern | ) |
Set the callee ID pattern for this rule.
A Rule is matched when all its patterns are matched.
An empty pattern is considered a wildcard pattern.
- Parameters
-
pattern The caller ID pattern.
◆ setCallerIdPattern()
| idempotent void setCallerIdPattern | ( | string | pattern | ) |
Set the caller ID pattern for this rule.
A Rule is matched when all its patterns are matched.
An empty pattern is considered a wildcard pattern.
- Parameters
-
pattern The caller ID pattern.
The documentation for this interface was generated from the following file:
- /usr/ports/net/smartswitch/work/smartswitch-9.1.60971/ice/Telephony/Forwarding/Rule.ice
