Plugin Keys

[Patrick Clinger]

This message is for ProBoards Developers that are creating plugins

We have not yet released our full developer guides, but there is one important point that I would like to make in case it impacts anyone while you work on plugins.

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.

---

I hope this is clear. If you have any questions, please ask.

[Kotomine]

How many keys does one receive by default, before having to buy further keys?

[Misaka]

Feb 28, 2013 4:46:22 GMT -8 Kotomine said:

How many keys does one receive by default, before having to buy further keys?

you have 10 regular keys and 2 super keys by default.

after that you need to buy more keys in-order to go further  

[Ty]

What is the difference between a key and a super key? So far all the plugins that I want to use either have no key or a super key which is a pain since only 2 are allowed.

[Misaka]

Mar 3, 2013 23:21:38 GMT -8 Ty said:

What is the difference between a key and a super key? So far all the plugins that I want to use either have no key or a super key which is a pain since only 2 are allowed.

the difference is a Private Key holds Thread, Post, Conversation, Message and Private User data and the Super User Key can store that is accessible by everyone on the forum.
 Whenever a user is displayed on the screen, their plugin key data will
be available to access.

most of what I said I found here

by default all Proboard Forums have 40 plugins, 10 keys and 2 super keys after you use up both super keys you willl need to by more the prices Vary from what you are looking for the best deal in there is if your a coder and you need more super keys would be the Super Key Pack for $22 but thats my opinion

[Pipperoo]

Is there a way to embed a soundcloud player into a thread? Do I need a plug in? I've been trying to figure this out all night. Thank you

[oxym0r0n]

Is there going to be a way to backup all of our key data so that if it gets cleared mistakenly we can restore it?

[Michael Stone]

Mar 15, 2013 16:33:43 GMT -8 Pipperoo said:

Is there a way to embed a soundcloud player into a thread? Do I need a plug in? I've been trying to figure this out all night. Thank you

There is a plugin for this! Check the Plugin Library. (I know this question is old, just answering it in case anyone else reads this thread and asks the same question.)

Apr 24, 2013 10:30:29 GMT -8 oxym0r0n said:

Is there going to be a way to backup all of our key data so that if it gets cleared mistakenly we can restore it?

Not currently. You're asking about the actual data that is being stored in the keys, correct? Thats all stored on our end. 

[oxym0r0n]

May 9, 2013 10:00:33 GMT -8 Michael Stone said:

<abbr data-timestamp="1366828229000" class="time" title="Apr 24, 2013 11:30:29 GMT -7">Apr 24, 2013 11:30:29 GMT -7</abbr> oxym0r0n said:

Apr 24, 2013 10:30:29 GMT -8 oxym0r0n said:

Is there going to be a way to backup all of our key data so that if it gets cleared mistakenly we can restore it?

Not currently. You're asking about the actual data that is being stored in the keys, correct? Thats all stored on our end. 

Yes, that's what I'm asking. I knew the data was stored on your end, but when I use set() on a key, it overwrites whatever was already in the key. If a bug causes someones key to get erased or set incorrectly, is there ever going to be a way to recover the history of the key data?

[Michael Stone]

There currently is no plans for that.