====== 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| |//''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| |//''sharedProps''//| dictionary | No |**[[api_release_notes:2.3|API v2.3]]** : an //''indigo.Dict()''// representing the name/value pairs that are shared by all plugins. This is the property dictionary that you can edit via the Global Properties plugin, and your plugin may manage properties in this dictionary as well to add metadata to devices that your plugin can use for other purposes. Use ''ag.replaceSharedPropsOnServer()'' to update them (as with pluginProps, you should get copy first, update the copy, then set them back to that copy so as to not accidentally remove some other plugin's props).| ==== 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 ^ |indigo.actionGroup.delete(123)| ^ 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 ^ |indigo.actionGroup.displayInRemoteUI(123, value=True)| |indigo.actionGroup.displayInRemoteUI(123, value=False)| ^ 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 ^ |indigo.actionGroup.duplicate(123, duplicateName="New Name")| ^ Parameters ^^^^ ^ Parameter ^ Required ^ Type ^ Description ^ |direct parameter| Yes | integer |id or instance of the action group to duplicate| |''//duplicateName//''| No | string |name for the newly action group trigger| === Execute === Execute the specified action group. ^ Command Syntax Examples ^ |indigo.actionGroup.execute(123)| ^ 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 ^ |indigo.actionGroup.moveToFolder(123, value=987)| ^ 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|