Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: typo
New_in
Version8.0.8


Scripting_function


Panel
titleDescription

Returns a dictionary of rosters, where the key is the name of the roster, and the value is an array list of string user names.

This function was designed to run in the Gateway and in Perspective sessions. If creating rosters from Vision clients, use system.alarm.getRosters instead.

Panel
titleSyntax

system.roster.getsRostersgetRosters()

  • Parameters

none

  • Returns

Dictionary A dictionary that maps roster names to a List of usernames in the roster. The List of usernames may be empty if no users have been added to the roster.

  • Scope

Gateway, Perspective Session

Panel
titleCode Examples
Code Block
languagepy
titleCode Snippet
# This example will print out all existing rosters to the console of a Perspective session:
  
rosters = system.roster.getRosters()	
	
# Iterate over the rosters, extracting the name and user lists
for name, users in rosters.items():
		
	# formatFormat the results in a somewhat presentable manner.
	msg = "{0} : {1}".format(name, users) 
		
	# output the result
	system.perspective.print(msg)
Code Block
languagepy
titleGet Each User in a Roster
# This example prints out each user in a certain roster. 
rosters = system.roster.getRosters()	
		
# Specify the roster with the key (the name of the roster), and iterate over the users.
for user in rosters['myRoster']:

	# output the users
	system.perspective.print(user)
Panel
titleKeywords

system roster getRosters, roster.getRosters