Skip to main content
Version: 8.1

system.roster.getRoster

New in 8.1.21

This function is used in Python Scripting.

Description

Returns the roster corresponding to the given name. You can call getUsers() to access a list of User objects in the RosterModel.

New in 8.1.29
Call getDescription() to access the Description field of the specified roster.

Syntax

system.roster.getRoster(rosterName)

Parameters

TypeParameterDescription
StringnameThe name of the roster to get the RosterModel object from.

Returns

RosterModel - The RosterModel object of the given roster name.

Scope

Gateway, Perspective Session

Code Examples

Code Snippet
# This example gets the RosterModel object from a roster called "some roster" when a Button is pressed and prints the object to the browser console.

roster = system.roster.getRoster("some roster")
system.perspective.print(roster)

Keywords

system roster getRoster, roster.getRoster