The ProBoards JavaScript API

[Wormopolis]

Yes

[Tim Camara]

For every plugin key, anyone who can access it will always return the same value. A private user plugin key doesn't give each user their own version of the same key, it's structured as a hash, with key/value pairs using user_id as the key. The global forum key simply removes the hash and replaces it (essentially) with a string.

tl;dr:
Yes.

[Texas]

Yea, I knew that much, I was just making sure it wasn't like a super user key that could be accessed everywhere.

[Wormopolis]

it is. it cam be accessed anywhere. the difference is, there is only one per forum instead of one per member, and it hold twice as much data.

[Wormopolis]

Is there a list of error codes?

[Tim Camara]

pb.plugin.status_codes();
Will give you the error code list.

[Chris]

Nov 25, 2013 9:17:14 GMT -8 Tim Camara said:

pb.plugin.status_codes();
Will give you the error code list.

pb.plugin.status_codes();
Object {ERROR_REQUEST_TIMEOUT: 1, ERROR_INVALID_RESPONSE: 2, ERROR_KEY_LENGTH: 16, ERROR_KEY_PERMISSION: 32, ERROR_KEY_INVALID_DATA: 64}



Fun.  I noticed 4 and 8 are missing though...

[Tim Camara]

I blame Michael Hill for that

[Chris]

Nov 26, 2013 8:20:36 GMT -8 Tim Camara said:

I blame Michael Hill for that

Real question though.  Would I ever get a combination back?  i.e. 3 for 1 + 2.

[Chris]

Da Missing Error Codes (by Dan Brown) said:

ERROR_INVALID_PLUGIN: 4
ERROR_QUOTA_EXCEEDED: 8

[Tim Camara]

Nov 26, 2013 21:05:55 GMT -8 Chris said:

Real question though.  Would I ever get a combination back?  i.e. 3 for 1 + 2.

No, it should only ever return the first error it encounters.

Also, I checked the code history, and apparently there never was an error 4 or 8.  

[Vu1canF0rce]

Could you guys put a link on the main ProBoards.com site possibly at the bottom under SUPPORT or LEARN a link to the API reference guide? This seems to be the only access point to the URL (other than obviously bookmarking it).

[Chris]

Dec 5, 2013 0:22:59 GMT -8 Vu1canF0rce said:

Could you guys put a link on the main ProBoards.com site possibly at the bottom under SUPPORT or LEARN a link to the API reference guide? This seems to be the only access point to the URL (other than obviously bookmarking it).

+1 for this.

[Tim Camara]

The developer area is still a work in progress. It will be added to the homepage links eventually though.

[Virgil Sovereign]

It would be nice to have a "newContent" event fired whenever new content is built into a thread. Currently (and correct me if I'm wrong on this) we have to bind to "pageChange", "afterSearch" and "columnSort" since all three dump any existing content and insert whatever is returned by the AJAX call. The "Events" thread also says that new events may be forthcoming. Having a single event to stand in for "anything that causes new content to be swapped in" would be useful.

As Wormopolis suggests, an editor API would be nice. I've actually written my own at that works on the principle of manifests. I'll finish it up and put it in the plugin library. Maybe developers will get some use out of it.

Documentation for the various dialog UIs (e.g. proboards.alert()) would also be welcome.