Post by PB Support on Oct 3, 2023 13:14:02 GMT -8
Plugin Keys
With Plugin Keys, you have the ability to get and store information on the ProBoards servers. Every time you set() a value on a key this will trigger an AJAX call to our server. Because of this, there is one important restriction that plugin authors must adhere to when creating a plugin:
You can only set() a value on a plugin key based on a user initiated action. For example, a user clicking on a button which triggers a set() call is acceptable. Automatically triggering a set() call with no user interaction, though, is prohibited.
Example of acceptable plugin:
You want to create a plugin to track how many people +1 a topic. You create a thread key, and have a button users can click to +1 the topic. When the user clicks the button, you call the plugin key's set() function which triggers the AJAX call.
Example of a prohibited plugin:
You want to count how many pageviews a user has on a forum. Every time a page is loaded, you automatically call set() on a user plugin key to increment a count.
With Plugin Keys, you have the ability to get and store information on the ProBoards servers. Every time you set() a value on a key this will trigger an AJAX call to our server. Because of this, there is one important restriction that plugin authors must adhere to when creating a plugin:
You can only set() a value on a plugin key based on a user initiated action. For example, a user clicking on a button which triggers a set() call is acceptable. Automatically triggering a set() call with no user interaction, though, is prohibited.
Example of acceptable plugin:
You want to create a plugin to track how many people +1 a topic. You create a thread key, and have a button users can click to +1 the topic. When the user clicks the button, you call the plugin key's set() function which triggers the AJAX call.
Example of a prohibited plugin:
You want to count how many pageviews a user has on a forum. Every time a page is loaded, you automatically call set() on a user plugin key to increment a count.