Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
blocks:api:query-parameters [2022-11-18 13:47]
admin
blocks:api:query-parameters [2024-05-16 11:02] (current)
admin Added class query param to edutor
Line 26: Line 26:
   * **spot** tells any active Locator to locate the spot specified by the value, which can be a Spot's Location ID, name or full path (with each level separated by a period).   * **spot** tells any active Locator to locate the spot specified by the value, which can be a Spot's Location ID, name or full path (with each level separated by a period).
   * **spot-id** applies a user-defined Spot ID instead of the server-generated number or player MAC address or Serial number. Avoid using a simple number as the ID, as that may collide with Blocks' internal IDs. You can use an arbitrary text as ID.   * **spot-id** applies a user-defined Spot ID instead of the server-generated number or player MAC address or Serial number. Avoid using a simple number as the ID, as that may collide with Blocks' internal IDs. You can use an arbitrary text as ID.
 +  * **display** adds a user-defined suffix to the spot's ID, letting you run multiple spots using the same browser without having the IDs conflict. Mainly for use from desktop/laptop computers when setting up multiple, concurrent display spots.
   * **param-Xxxx** defines the initial value of Spot Parameter Xxxx to be the value supplied.   * **param-Xxxx** defines the initial value of Spot Parameter Xxxx to be the value supplied.
  
Line 43: Line 44:
 The advantage of using child block names instead of their index is that the name is more reliable if child blocks are added or removed (e.g., a new slide is added at the beginning of the Slideshow in the example above). The advantage of using child block names instead of their index is that the name is more reliable if child blocks are added or removed (e.g., a new slide is added at the beginning of the Slideshow in the example above).
  
-:!: **IMPORTANT**: Make sure you any the query parameters //before// any # sign in the URL, as shown below.+:!: **IMPORTANT**: Make sure to put query parameters //before// any # sign in the URL, as shown below.
  
 ====sandbox==== ====sandbox====
Line 65: Line 66:
  
 :!: **IMPORTANT**: This parameter prevents the user from //accidentally// leaving the designated group or creating blocks in other groups. Just like the sandbox parameter, this is not a security feature. By deliberately modifying the URL in the browser, a user can still access other groups. :!: **IMPORTANT**: This parameter prevents the user from //accidentally// leaving the designated group or creating blocks in other groups. Just like the sandbox parameter, this is not a security feature. By deliberately modifying the URL in the browser, a user can still access other groups.
 +
 +====class====
 +
 +Applies a CSS class to the speditor's #main element, where the value is the CSS class name. This can then be used to style editors differently, hide elements, etc, using CSS. More about CSS styling [[blocks:custom_styling|here]].