Initializing help system before first use

xpressinsight.AppInterface.get_messages

Purpose
Returns a generator for reading the messages sent to the scenario.
Synopsis
xpressinsight.AppInterface.get_messages(self) -> Generator[str, NoneType, NoneType]
Example
Read messages and display them until there are none left: 
>>> for msg in insight.get_messages():
...     print("Received message: ", msg)
Further information
1. Messages are typically sent from views as a way to inform an executing scenario of a user action.
2. The format of a message is not defined, beyond being a string.
3. The executing Insight scenario can only receive messages in Insight v5 and later. If called from a scenario running in Insight v4, the generator will always yield no values.
4. When test mode has been activated, this function will return messages from a queue populated by the insight.put_messages method.
Related topics
AppInterface.put_messages

Parent Topic App Interface Classes

© 2001-2024 Fair Isaac Corporation. All rights reserved. This documentation is the property of Fair Isaac Corporation (“FICO”). Receipt or possession of this documentation does not convey rights to disclose, reproduce, make derivative works, use, or allow others to use it except solely for internal evaluation purposes to determine whether to purchase a license to the software described in this documentation, or as otherwise set forth in a written software license agreement between you and FICO (or a FICO affiliate). Use of this documentation and the software described in it must conform strictly to the foregoing permitted uses, and no other use is permitted.