on_eval_entity Event

Fired every time an entity needs to be evaluated.

Syntax

class RESTEvalEntityEventParams(object):
  @property
  def entity() -> str: ...
  @property
  def value() -> str: ...
  @value.setter
  def value(value) -> None: ...

# In class REST:
@property
def on_eval_entity() -> Callable[[RESTEvalEntityEventParams], None]: ...
@on_eval_entity.setter
def on_eval_entity(event_hook: Callable[[RESTEvalEntityEventParams], None]) -> None: ...

Remarks

The Value parameter contains a suggested value for the entity (normally the entity name itself). You may set Value to a value of your choice, which will be later passed into the text stream.

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks 2020 Python Edition - Version 20.0 [Build 8307]