system.roster.removeUsers
This function is used in Python Scripting.
Description​
Removes one or more users from an existing roster.
Syntax​
system.roster.removeUsers(rosterName, users)
Parameters​
| Type | Parameter | Description |
|---|---|---|
| String | rosterName | The name of the roster to modify. |
| List | users | A list of user objects that will be removed from the roster. User objects can be created with the system.user.getUser and system.user.addUser functions. |
Returns​
Nothing
Scope​
Gateway, Perspective Session
Code Examples​
Code Snippet
userSource = "default"
rosterName = "rosterEast"
# getUser() returns a user object, which is needed for removeUser()
user = system.user.getUser(userSource, "joe")
system.roster.removeUsers(rosterName, [user])