getUsersByCommunities
Returns a list of users by community to which they have access.
Syntax
Parameter | Data type | Description |
---|---|---|
sourceName | string | Logical name of the local community. |
destName | string | Logical name of the external or clearinghouse community. |
capabilities | integer | Numerical index for capabilities. Only 2
(all capabilities) is supported.
|
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 users to return. |
Purpose
The getUsersByCommunities
command
returns a list of users 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. User operations may
only be performed on all capabilities.
Sample
set ons [$AdminControl completeObjectName type=RTCAdminMbean,*] set local [$AdminControl invoke $ons getLocalCommunityName] $AdminControl invoke $ons getUsersByCommunities "$local company 2 0 10"