Jump to content

Community

Developer Documentation

Checking for updates in your application, plugin or theme

IPS Community Suite can periodically check for updates to your application, plugin or theme and present a message in the Admin CP if an update is available.

When creating your application, plugin or theme you can specify a URL that the IPS Community Suite will use to check whether an update is available.

update_url.png
"Update URL" field when creating a plugin

IPS Community Suite will send a request to the specified URL periodically with a "version" parameter specifying the current version ID number. For example, if you specify the URL as:

http://www.example.com/myapp/check.php

And someone is using a version of your application with the version ID "10002", then the request will be sent to:

http://www.example.com/myapp/check.php?version=10002

This URL should return with a JSON-encoded object with the following properties:

  • version 
    The human-readable version number (e.g. "2.0.0") of the latest version available
  • longversion
    The version ID number (e.g. "20000") of the latest version available
  • released
    The unix timestamp of the date that version was released
  • updateurl
    The URL where the administrator can download the update

For example, you might return something like this:

{
    "version": "2.0.0",
    "longversion": 20000,
    "released": 1423841958,
    "updateurl": "http://www.example.com/myapp/download"
}

For a live example, the URL for checking for updates to the IPS Community Suite itself is:

http://remoteservices.invisionpower.com/updateCheck

You can visit this URL to see what is returned for the IPS Community Suite.


  Report Document


×
×
  • Create New...