removeUserByCommunities

Removes a user so that the user cannot access an external or clearinghouse community.

Syntax

removeUserByCommunities sourceName, destName, capability, username
Parameter Data type Description
sourceName string Logical name of the local community.
destName string Logical name of the external or clearinghouse community.
capability integer Numerical index for capabilities. Only 2 (all capabilities) is supported.
  • 0 returns instant messaging
  • 1 returns presence
  • 2 returns all capabilities
username string User name.

Purpose

The removeUserByCommunities command removes a user with specified capabilities and prevents them from accessing the named external community. Capabilities are numerically indexed. 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 removeUserByCommunities $local aol 2 jsmith