Skip to content

Commit

Permalink
#1 Fix references to the StreamDeckActionAttribute (accidentally incl…
Browse files Browse the repository at this point in the history
…uded the 'Attribute' suffix).
  • Loading branch information
ipointer-certifid committed Aug 6, 2021
1 parent 7f241a1 commit de9ac48
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ The Stream Deck Toolkit provides the functionality that communicates directly wi

2. BaseStreamDeckActionWithSettingsModel<T> - this class inherits from BaseStreamDeckAction, this class will automate the population of model properties, where type T is defined as the data that is stored when issuing a 'setSettings' event to the Stream Deck software. The property **SettingsModel** will automatically instantiate an instance of class T, so it is best to assign default values when defining your class T. Also, when using the Property Inspector and passing data back and forth, ensure that the properties defined in the settingsModel in JavaScript matches those that you have defined in T for the automatic mapping to occur between both environments.

Your project may contain any number of actions, inheriting from one of the classes above. In order for the Action to be automatically registered on start up, it must bear the **[StreamDeckActionAttribute(Uuid="com.fritzanfriends.pluginname.anotheraction")]** attribute, and have a UUID set via the attribute, or by overloading `ActionUuid` in your `BaseStreamDeckAction` implementation.
Your project may contain any number of actions, inheriting from one of the classes above. In order for the Action to be automatically registered on start up, it must bear the **[StreamDeckAction(Uuid="com.fritzanfriends.pluginname.anotheraction")]** attribute, and have a UUID set via the attribute, or by overloading `ActionUuid` in your `BaseStreamDeckAction` implementation.

Actions must also be manually registered in the **manifest.json** file, with the Uuid that matches the one set with the `StreamDeckActionAttribute`, or an `ActionUuid` overload of the `BaseStreamDeckAction.ActionUuid` property.

Expand Down
2 changes: 1 addition & 1 deletion docs/articles/create.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,6 @@ The Stream Deck Toolkit provides the functionality that communicates directly wi

2. `BaseStreamDeckActionWithSettingsModel<T>` - this class inherits from BaseStreamDeckAction, this class will automate the population of model properties, where type T is defined as the data that is stored when issuing a 'setSettings' event to the Stream Deck software. The property **`SettingsModel`** will automatically instantiate an instance of class T, so it is best to assign default values when defining your class T. Also, when using the Property Inspector and passing data back and forth, ensure that the properties defined in the settingsModel in JavaScript matches those that you have defined in T for the automatic mapping to occur between both environments.

Your project may contain any number of actions, inheriting from one of the classes above. In order for the Action to be automatically registered on start up, it must bear the **[StreamDeckActionAttribute(Uuid="com.fritzanfriends.pluginname.anotheraction")]** attribute, and have a UUID set via the attribute, or by overloading `ActionUuid` in your `BaseStreamDeckAction` implementation.
Your project may contain any number of actions, inheriting from one of the classes above. In order for the Action to be automatically registered on start up, it must bear the **[StreamDeckAction(Uuid="com.fritzanfriends.pluginname.anotheraction")]** attribute, and have a UUID set via the attribute, or by overloading `ActionUuid` in your `BaseStreamDeckAction` implementation.

Actions must also be manually registered in the **manifest.json** file, with the Uuid that matches the one set with the `StreamDeckActionAttribute`, or an `ActionUuid` overload of the `BaseStreamDeckAction.ActionUuid` property.
2 changes: 1 addition & 1 deletion docs/articles/template/action.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ You will also have a model created `CounterSettingsModel` which will be set.

### Attribute

[StreamDeckActionAttribute(Uuid="com.yourcompany.pluginname.actionname")]
[StreamDeckAction(Uuid="com.yourcompany.pluginname.actionname")]

### Class Name

Expand Down

0 comments on commit de9ac48

Please sign in to comment.