Smartswitch
Operations | List of all members
Smartswitch::Telephony::QueueMember Interface Reference

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

defined in <QueueMember.ice>

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

Inheritance diagram for Smartswitch::Telephony::QueueMember:
Inheritance graph
[legend]
Collaboration diagram for Smartswitch::Telephony::QueueMember:
Collaboration graph
[legend]

Operations

idempotent int getPenalty () throws AccessException
 Obtain the QueueMember penalty. More...
 
Peer::UsergetUser () throws AccessException
 Obtain the proxy to a User which is configured as the member of Queue. More...
 
idempotent bool isEnabled () throws AccessException
 Check if the QueueMember is enabled at the moment. More...
 
void remove () throws AccessException
 Remove a given QueueMember. More...
 
idempotent void setEnabled (bool enabled) throws AccessException
 Enable or disable the QueueMember. More...
 
idempotent void setPenalty (int penalty) throws AccessException
 Set the QueueMember penalty. 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 QueueMember.

Operation Documentation

◆ getPenalty()

idempotent int getPenalty ( ) throws AccessException

Obtain the QueueMember penalty.

Penalty is used to give a given QueueMember less priority when compared with other members of a Queue.

Returns
Current penalty of a QueueMember.

◆ getUser()

Peer::User* getUser ( ) throws AccessException

Obtain the proxy to a User which is configured as the member of Queue.

Returns
The proxy for an existing User.

◆ isEnabled()

idempotent bool isEnabled ( ) throws AccessException

Check if the QueueMember is enabled at the moment.

Returns
true if the QueueMember is enabled.

◆ remove()

void remove ( ) throws AccessException

Remove a given QueueMember.

◆ setEnabled()

idempotent void setEnabled ( bool  enabled) throws AccessException

Enable or disable the QueueMember.

Parameters
enabledtrue if the QueueMember should be enabled.

◆ setPenalty()

idempotent void setPenalty ( int  penalty) throws AccessException

Set the QueueMember penalty.

Penalty is used to give a given QueueMember less priority when compared with other members of a Queue.

Parameters
penaltyThe new penalty of a QueueMember.

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