getGroups

Returns a list of groups.

Syntax

getGroups routeUid, capability, index, pageSize
Table 1. getGroups 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
index integer Page at which to start returning pages specified by pageSize. For example, if index is 0 and pageSize is 10, the command returns pages 1 to 10. If the index is 1 and the pageSize is 18, the command returns pages 2 to 19.
pageSize integer Number of pages of groups to return.

Purpose

The getGroups command returns a list of groups associated with the specified capability on the named route for the named community. Capabilities are numerically indexed. Additionally, the command returns pageSize entries at a time starting at index. Group operations may only be performed on all capabilities.

Sample

set ons [$AdminControl completeObjectName type=RTCAdminMbean,*]
set local [$AdminControl invoke $ons getLocalCommunityName]
$AdminControl invoke $ons getGrooups "$somerouteuid 2 0 10"