Smartswitch
Operations | List of all members
Smartswitch::Peer::UserGroup Interface Reference

This interface allows to manipulate a UserGroup. More...

defined in <UserGroup.ice>

interface UserGroup extends Smartswitch::Peer::GenericPeer { ... }

Inheritance diagram for Smartswitch::Peer::UserGroup:
Inheritance graph
[legend]
Collaboration diagram for Smartswitch::Peer::UserGroup:
Collaboration graph
[legend]

Operations

UserCallerIdaddCallerId (string callerNumber, string calleeIdPattern, string realCalleeIdPattern) throws AccessException, DuplicateException
 Attach the new UserCallerId replacement rule to the UserGroup. More...
 
UserCallerIdSequence getCallerIds () throws AccessException
 Obtain the UserCallerId objects attached to the UserGroup. More...
 
- Operations inherited from Smartswitch::Peer::GenericPeer
CompanygetCompany () throws AccessException
 Obtain the proxy to a Company which is bound to this GenericPeer. More...
 
idempotent long getId ()
 Obtain the unique constant ID of a GenericPeer. More...
 
idempotent string getName () throws AccessException
 Obtain the name of a GenericPeer. More...
 
VariableSequence getVariables () throws AccessException
 Obtain the custom variables attached to the GenericPeer. More...
 
void insertVariable (Variable variable) throws AccessException
 Add a custom variable to the GenericPeer. More...
 
- Operations inherited from Smartswitch::Destroyable
void destroy ()
 Destroy the proxy entity at the Smartswitch side. More...
 

Detailed Description

This interface allows to manipulate a UserGroup.

Operation Documentation

◆ addCallerId()

UserCallerId* addCallerId ( string  callerNumber,
string  calleeIdPattern,
string  realCalleeIdPattern 
) throws AccessException, DuplicateException

Attach the new UserCallerId replacement rule to the UserGroup.

Returns
The proxy for UserCallerId which is attached to the UserGroup.
Parameters
callerNumberThe caller number to bind to the UserGroup.
calleeIdPatternUse above caller number of the callee number matches this pattern.
Pass empty to match any callee number.
realCalleeIdPatternUse above caller number of the real callee number (a number with prefix) matches this pattern.
This could be used if you want to allow user to pick up a specific caller number by adding a prefix to a called number.
Pass empty to match any real callee number.
See also
getCallerIdSequence()

◆ getCallerIds()

UserCallerIdSequence getCallerIds ( ) throws AccessException

Obtain the UserCallerId objects attached to the UserGroup.

These settings are used by the Smartswitch to replace a caller number and caller name for the calls from any User of the UserGroup.
This is needed to bind a specific A-number and A-name to the user, so that he won't be able to call using other user's caller information.
The latter is considered a crime in many countries and thus it's needed to use this function in a safe User configuration.

Returns
The sequence of UserCallerId objects attached to the UserGroup.
See also
addCallerId()

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