API Reference


The Event methods allow you to create events with a start and end-time, allow groups of users to join and manage media within that event.
Events.addMember

Adds a member to an event.

This can be used by registered users to add themselves to events within the vhosts their user is in. This requires the user to be logged in. In this case both "uid" and "memberType" should be left as their defaults.

This may also be used by privileged users (those with the events.addMember permission) to add other users within the event's vhost to a read more »

Events.createEvent

Use this method to create an event and have the new event ID returned.

read more »
Events.getEvent

Returns information about a specific event.

read more »
Events.getEvents

Returns a list of events for a specific vhost.

Pagination may be controlled via the "startPage" and "pageSize" parameters

The optional "sort" argument is a string that can be used to specify one field to sort the returned events by.The sort parameter can also include a sort direction ("ASC" or "DESC").

All events returned will have a last resort sort applied based on the read more »

Events.isMediaInEvent

Checks whether a media item is in an event.

A simple boolean will be returned, 1 if the media item is in the event, 0 otherwise.

read more »
Events.removeMember

Removes a member from an event.

This can be used by registered users to remove themselves from a group they're a member of. In this case the "uid" parameter should be left as its default.

This may also be used by privileged users (those with the events.removeMember permission) to remove other users within the event's vhost from an event.

read more »
Events.updateEvent

Updates event information based on a event ID.

read more »
Events.updateMember

Updates a member's status in an event.

This can be used to promote a member to admin, or demotion.

The possible member types are 1 = invited, 2 = member and 9 = admin.

read more »
Events.isUserInEvent

Checks whether a user is in an event.

A simple boolean will be returned, true if the user is in the event, false otherwise.

If includeChildren is true then this function will return true if the user is in the event specified or any of its descendants (its descendants can be both groups and events).

read more »
Events.addMedia

Adds a media item to an event.

read more »
Events.removeMedia

Removes a media item from an event.

read more »