event_mgr_update

Back to SOAP Architecture Method Reference

Description

The event_mgr_update method updates the designated Events with the provided details.

Parameters

Parameter Description Type Required (R) or Optional (O)
domain_id The unique ID# of the domain. bstypes:ResourceId R
id The unique ID# of this event. bstypes:ResourceId R
name The updated name of this event. string R
state The updated state of this event. bstypes:ReservationState R
active Whether this event is active. boolean O
bmb_host_id The updated ID# of the Broadsign Creator Player assigned to this event. bstypes:ResourceId O
container_id The updated ID# of the folder where this event exists. bstypes:ResourceId O
default_attributes The udpated attributes of the custom geometry for this event in a comma seperated key-value pairs. string O
default_fullscreen Whether this event goes in fullscreen mode or custom geometry. boolean O

Return Values

Value Description Type Required (R) or Optional (O)
id The unique ID# of this event. bstypes:ResourceId R