system.roster.addUsers

This function is used in Python Scripting.

Description

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

Syntax

system.roster.addUsers(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 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

Nothing

Scope

Gateway, Perspective Session

Code Examples

Code 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])