Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: edits/style
Scripting_function


Panel
titleDescription

Adds a list of users to an existing roster. Users are always appended to the end of the roster.

Panel
titleSyntax

system.roster.addUsers(rosterName, [users])

  • Parameters

String rosterName- The name of the roster to modify.

List users - A list of User objects that will be added to the end of the roster. User objects can be created with the system.user.getUser and system.user.addUser functions. These users must exist before being added to the roster. 

  • Returns

noneNothing

  • Scope

Gateway, Perspective Session

Custompanel
titleCode Examples
Code Block
languagepy
titleCode Snippet
# Adds a couple of users to a roster. 
userSource = "default"
rosterName = "rosterEast"
	
# getUser() returns a user object, which is needed for addUser() 
userA = system.user.getUser(userSource, "george")
userB = system.user.getUser(userSource, "joe")
	
system.roster.addUsers(rosterName, [userA, userB])

Panel
titleKeywords

system roster addUsers, roster.addUsers