hi5 Javascript API

The Javascript API allows you to access the hi5 data via an OpenSocial Interface.

1. hi5.Album
   
2. hi5.Photo
   
3. hi5.Presence
   

---

hi5.Album

In hi5 all photos are contained in an album. This class allows you to get various properties of a user's photo album. Here are a list of method calls:

album.getCount()
Returns the number of albums the user has.

album.getCover()
Returns the album image for a particular album.

album.getField(key)

album.getId()
Returns the internal Id for an album.

album.getName()
Returns the name of the album.

album.getPhotos()
Returns the list of photos that a user has in their album

hi5.Photo

This class returns the details about a particular photo in a user's album.

photo.getDescription()
Returns the description of the photo.

photo.getField(key)

photo.getUrl()
Returns the URL for a given photo.

hi5.Presence

presence.getField(key)

presence.getUserId()
Returns the Id of the user who is currently online.hi5.Status

status.getField(key)

status.getText()
Returns the text of a user's status update.

status.getTimeAdded()
Returns the time that the user updated their status

status.getUserId()
Returns the user Id of the person who updated their status'