getNumOfUsers

Returns the number of users that are present on a given route and capability.

Syntax

getNumOfUsers routeUID, capability
Table 1. getNumOfUsers syntax
Parameter Data type Description
routeUid string UID of route between the local and external community.
capability integer Numerical index for capabilities. Only 2 (all capabilities) is supported.
  • 0 returns instant messaging
  • 1 returns presence
  • 2 returns all capabilities

Purpose

The getNumOfUsers command returns the number of users present on a given route and capability.

Sample

set ons [$AdminControl completeObjectName type=RTCAdminMbean,*]
$AdminControl invoke $ons getNumOfUsers "$somerouteuid 2"