Differences

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

Link to this comparison view

Both sides previous revision Previous revision
indigo_7_documentation:action_group_class [2018/11/28 00:03] – [Duplicate] jayindigo_7_documentation:action_group_class [2025/02/18 20:36] (current) – external edit 127.0.0.1
Line 1: Line 1:
 +====== Action Groups ======
 +
 +At the moment, editing of action groups is fairly limited and you can't actually create new action groups (aside from duplicating an existing group). We will eventually add this functionality but so far demand has made it a lower-priority item.
 +
 +==== Class Properties ====
 +
 +^  Property  ^  Type  ^  Writable  ^  Description  ^
 +|//''description''//|  string  |  Yes  |description of the action group|
 +|//''folderId''//|  integer  |  No  |unique ID of the folder this action group is in|
 +|//''id''//|  integer  |  No  |a unique id of the action group, assigned on creation by IndigoServer - not available in AppleScript|
 +|//''name''//|  string  |  Yes  |the unique name of the action group - no two action groups can have the same name|
 +|//''remoteDisplay''//|  boolean  |  No  |''True'' if this action group is shown in remote clients, ''False'' otherwise|
 +
 +==== Commands (indigo.actionGroup.*) ====
 +
 +The commands in this section are common to all triggers regardless of type.
 +
 +=== Delete ===
 +
 +Delete the specified action group.
 +
 +^  Command Syntax Examples  ^
 +|<code>indigo.actionGroup.delete(123)</code>|
 +
 +^  Parameters  ^^^^
 +^  Parameter  ^  Required  ^  Type  ^  Description  ^
 +|direct parameter|  Yes  |integer|id or instance of the action group to delete|
 +
 +=== Display In Remote UI ===
 +
 +This command will show or hide the action group in remote clients.
 +
 +^  Command Syntax Examples  ^
 +|<code>indigo.actionGroup.displayInRemoteUI(123, value=True)</code>|
 +|<code>indigo.actionGroup.displayInRemoteUI(123, value=False)</code>|
 +
 +^  Parameters  ^^^^
 +^  Parameter  ^  Required  ^  Type  ^  Description  ^
 +|direct parameter|  No  |  integer  |id or instance of the action group|
 +|''//value//''|  Yes  |  boolean  |''True'' to show the action group or ''False'' to hide it|
 +
 +=== Duplicate ===
 +
 +Duplicate the specified action group. This method returns a copy of the new action group.
 +
 +^  Command Syntax Examples  ^
 +|<code>indigo.actionGroup.duplicate(123, duplicateName="New Name")</code>|
 +
 +^  Parameters  ^^^^
 +^  Parameter  ^  Required  ^  Type  ^  Description  ^
 +|direct parameter|  Yes  |  integer  |id or instance of the action group to duplicate|
 +|''//duplicateName//''|  No  |  string  |name for the new action group trigger|
 +=== Execute ===
 +
 +Execute the specified action group.
 +
 +^  Command Syntax Examples  ^
 +|<code>indigo.actionGroup.execute(123)</code>|
 +
 +^  Parameters  ^^^^
 +^  Parameter  ^  Required  ^  Type  ^  Description  ^
 +|direct parameter|  Yes  |  integer  |id or instance of the action group to execute|
 +
 +=== Move To Folder ===
 +
 +Use this command to move the action group to a different folder. You can get a list of folder id’s by using indigo.actionGroups.folders, which will return a dictionary. The key to the dictionary is the ID, the value is the folder name.
 +
 +^  Command Syntax Examples  ^
 +|<code>indigo.actionGroup.moveToFolder(123, value=987)</code>|
 +
 +^  Parameters  ^^^^
 +^  Parameter  ^  Required  ^  Type  ^  Description  ^
 +|direct parameter|  Yes  |  integer  |id or instance of the action group|
 +|''//value//''|  Yes  |  integer  |id or instance of the folder to move the action group to|