• Square/circle/text indicator
  
• Custom images
  
• Custom links
  
• Check for multiple users
  

www.blocks.scratchr.org/API.php?action=userStatus&user=sparks

Example #1 - Returning a status dot or text

The [type] parameter is required here. If the parameter isn't specified it defaults to round which will return a circular online or offline image. However you can set the [type] parameter to square ( and ) or text ( and ).

www.blocks.scratchr.org/API.php?action=userStatus&user=sparks&type=square

will return or

www.blocks.scratchr.org/API.php?action=userStatus&user=sparks&type=text

will return or

Example #2 - Displaying a specific image based on online status

The [online] and [offline] parameters are required here, however the [type] parameter can be left out.

www.blocks.scratchr.org/API.php?action=userStatus&user=sparks&online=scratchdoesntcurrentlylikeimageshack1&offline=scratchdoesntcurrentlylikeimageshack2

will return scratchdoesntcurrentlylikeimageshack1 or scratchdoesntcurrentlylikeimageshack2, two custom images.
Note: If either the [online] or [offline] parameters are left out, the image for their status will default to round

Example #3 - Creating an online/offline dependant URL

This requires the otherwise unused [return] parameter. If not used, [return] defaults to image but setting it to link will redirect the user to the specified link. Remember to place this inside an url tag not an img tag.

www.blocks.scratchr.org/API.php?action=userStatus&user=sparks&return=link&online=http://www.accidentalgames.com&offline=http://mv.ezproxy.com.ezproxyberklee.flo.org/users/sparks

Will return a link to my website if I'm online and to my profile if I'm offline.

Example #4 - Checking for multiple users at once

You can check up to a total of four users at once using the [user2], [user3] and [user4] parameters. These additional user checkers can be applied to any of the above examples. The API will consider the return to be online if one or more users are found to be online.

www.blocks.scratchr.org/API.php?action=userStatus&user=sparks&user2=lightnin&user3=Paddle2See&user4=jvvg

will return a if any of the four users sparks. lightnin, Paddle2See or jvvg are online.

parameters marked with [square brackets] are optional

user
The username of the user to check. Case sensitive.

[user2] [user3] [user4]
Used to check up to another three usernames. The API will return as online if any one of the specified users is online. Case sensitive.

[type]
The return type if you want a coloured dot. Must be: round, square or text. Defaults to round if not specified.

[online]
If you want a specific image to appear when user is online then the URL for the image goes here.

[offline]
If you want a specific image to appear when user is offline then the URL for the image goes here.

[return]
If you want to use the userStatus function as a link rather than an image then use this by setting [return] to link. Defaults to image if not specified.

API (Application Programming Interface) - An application that lets users or another piece of code interact with something else.
Function - a task or process to perform, Getting the online status of a user, for example.
Parameter - Another name for variable. Examples of API parameters are the name of a user or the link to redirect to.

Parameters are marked in blue text like these: user, [return] whenever they are referred to. If you see blue text, its a parameter. Parameters are inputs that tell the API specifically what you want it to do. To see a list of parameters a particular function can use, scroll to the bottom of the documentation post for that function.

Examples contain an example link showing how an API function can be used in grey text with a description above. These are examples to show how an API link should be laid out and can easily be modified.

The API takes the form of a URL which you can place into an [img] or [url] tag, either in a post or in your forum signature.

Syntax
Parameters are seperated by an & symbol. If you want to enter & as a text character type %26 instead. Spaces cannot be entered into an URL, use either an underscore( _ ) or %20 for spaces.

sparks wrote:

^Home

QuillzToxic wrote:

I think I made dis before u XD
So Duplicate…

But if you wish you can close mine XD

3rd non-op post DDDDDDDDDDDDD

blob8108 wrote:

Use http://scratch.mit.edu.ezproxyberklee.flo.org/discuss/topic/30239/?page=1#post-259769 for the home links, so it doesn't reload the whole page.

sparks wrote:

QuillzToxic wrote:

I think I made dis before u XD
So Duplicate…

But if you wish you can close mine XD

3rd non-op post DDDDDDDDDDDDD

Yeah, I kinda noticed you'd done a thread about the API once I started again here. I hope you don't mind? Thing is the API is kinda broken atm for the new Scratch version and I figured that I should rewrite the documentation properly for the fixes.

blob8108 wrote:

Use http://scratch.mit.edu.ezproxyberklee.flo.org/discuss/topic/30239/?page=1#post-259769 for the home links, so it doesn't reload the whole page.

Thanks for the tip! That's awesome!