system.roster.getUsers
This function is used in Python Scripting.
Description​
Returns the list of users corresponding to the given rosterName.
Syntax​
system.roster.getUsers(rosterName)
Parameters​
| Type | Parameter | Description |
|---|---|---|
| String | rosterName | The name of the roster to get a list of users from. |
Returns​
List[String] - List of users within the specified roster.
Scope​
Gateway, Perspective Session
Code Examples​
Code Snippet
# This script gets a list of users within a specified roster and prints their
# information to the browser console.
users = system.roster.getUsers("myRoster")
system.perspective.print(users)