Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Scripting_function


Panel
titleDescription

Removes one or more users from an existing roster. 

Panel
titleSyntax

system.roster.removeUsers(rosterName, users)

  • Parameters

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

Panel
titleCode Examples
Code Block
languagepy
titleCode 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])
Panel
titleKeywords

system roster removeUsers, roster.removeUsers