fmIDE 'Name that Thing' API Parameters

The following table shows the parameters for the fmIDE 'Name that Thing' API, and their state of development. [^1]

Legend

Categories

1. thing_name - for identifying things by name (well developed)
2. thing_number - for identifying things by number (= position in list = currently only script steps)
3. thing_id - for identifying things by internal id (some)
4. thing_uuid - for identifying things by internal uuid (pipe dream)
5. General parameters
6. Actions - these Action parameters go beyond the 'Name that Thing' API
7. Action parameters - action parameters which trigger a default action

Dev-State

• ok - implemented and generally ok (but everything is under scrutiny at the moment)
• beta - implemented and at beta testing stage = not expected to change
• alpha - implemented and at alpha testing stage = likely to change
• ? - state currently unknown
• idea - not implemented but something to work towards
• dream - not implemented, maybe never, maybe one day if the world changes

Types of thing

fmIDE currently recognises the following object types

• account
• base_table
• custom_function
• custom_menu
• custom_menu_item
• custom_menu_set
• external_data_source
• extended_privilege
• field
• layout
• layout_field
• object
• privilege_set
• script
• script_step
• table
• theme
• value_list
• window

Parameters

Category	Parameter Name	Data Type	Dev State	Default Action	Description
1	account_name	String	beta	Go to Account
1	base_table_name	String	beta	Go to Base Layout
1	custom_function_name	String	beta	Go to Custom Function
1	custom_menu_item_name	String	beta	Go to Custom Menu
1	custom_menu_name	String	beta	Go to Custom Menu Item
1	custom_menu_set_name	String	beta	Go to Custom Menu Set
1	extended_privilege_name	String	beta	Go to Extended Privilege
1	external_data_source_name	String	beta	Go to External Data Source
1	field_name	String	alpha	Go to Table
1	layout_field_name	String	alpha	Go to Layout Field
1	layout_name	String	beta	Go to Layout
1	layout_part_name	String	alpha	Go to Layout Part
1	object_name	String	beta	Go to Object
1	privilege_set_name	String	beta	Go to Privilege Set
1	script_name	String	beta	Go to Script
1	script_name_stub	String	beta	Go to Script
1	script_step_name	String	beta	Find Script Step
1	t_o_name	String	beta	Go to Table Occurrence
1	table_name	String	beta	Go to Table
1	theme_name	String	beta	Go to Theme
1	value_list_name	String	beta	Go to Value List
2	account_number	Number	idea
2	base_table_number	Number	idea
2	custom_function_number	Number	idea
2	custom_menu_item_number	Number	idea
2	custom_menu_number	Number	idea
2	custom_menu_set_number	Number	idea
2	extended_privilege_number	Number	idea
2	external_data_source_number	Number	idea
2	field_number	Number	idea
2	layout_field_number	Number	idea
2	layout_number	Number	idea
2	layout_part_number	Number	idea
2	object_number	Number	idea
2	privilege_set_number	Number	idea
2	script_number	Number	idea
2	script_step_number	Number	beta
2	script_step_number_to	Number	beta
2	t_o_number	Number	idea
2	table_number	Number	idea
2	theme_number	Number	idea
2	value_list_number	Number	idea
3	account_id	Number	idea
3	base_table_id	Number	idea
3	custom_function_id	Number	idea
3	custom_menu_id	Number	idea
3	custom_menu_item_id	Number	idea
3	custom_menu_set_id	Number	idea
3	extended_privilege_id	Number	idea
3	external_data_source_id	Number	idea
3	field_id	Number	alpha
3	layout_field_id	Number	idea
3	layout_id	Number	beta
3	layout_part_id	Number	idea
3	object_id	Number	idea
3	privilege_set_id	Number	idea
3	script_id	Number	beta
3	script_step_id	Number	beta
3	t_o_id	Number	idea
3	table_id	Number	idea
3	theme_id	Number	idea
3	value_list_id	Number	idea
4	account_uuid	String	dream
4	base_table_uuid	String	dream
4	custom_function_uuid	String	dream
4	custom_menu_item_uuid	String	dream
4	custom_menu_set_uuid	String	dream
4	custom_menu_uuid	String	dream
4	extended_privilege_uuid	String	dream
4	external_data_source_uuid	String	dream
4	field_uuid	String	dream
4	layout_field_uuid	String	dream
4	layout_part_uuid	String	dream
4	layout_uuid	String	dream
4	object_uuid	String	dream
4	privilege_set_uuid	String	dream
4	script_step_uuid	String	dream
4	script_uuid	String	dream
4	t_o_uuid	String	dream
4	table_uuid	String	dream
4	theme_uuid	String	dream
4	value_list_uuid	String	dream
5	fmide_debug	Boolean	beta		If true, shows a dialog for debugging
6	[…]	Array	beta	-	An array of actions
6	action	Object	beta	-	A single action objet
6	action_name	String	beta	-	The name of a single action
6	actions	Object	beta	-	An actions object (containing an array of actions)
7	curl_options	String	beta	Insert from URL
7	fmxmlsnippet	String	beta	Set Clipboard Objects
7	fmxmlsnippet_value	String.Calc	beta	Set Clipboard Objects
7	message	String	beta	Show Custom Dialog
7	message_value	String	beta	Show Custom Dialog
7	script_step_search	String	beta	Find Script Step	Text to search for
7	script_step_search_value	String.Calc	beta	Find Script Step	Calculation is evaluated
7	url	String	beta	Open URL
7	window_name	String	beta	Select Window

[^1]:This page was generated semi-automatically from the fmIDE master file. Please do not edit manually!