API Reference

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).


Syntax

bool events.isUserInEvent ( int eventID, int userID, bool includeChildren = false )

Arguments

NameTypeRequiredDefault valueDescription
eventIDintRequirednoneThe event ID to check if the user is a member of.
userIDintRequirednoneThe user ID that we are checking to see if they are in the event.
includeChildrenboolOptionalfalseBy default this is false. Possible values are true or false. This will treat the group ID as the parent and if it has any children it will check and return a response, 1 or 0 if the specified user ID is in the supplied event ID or any of the children events.

Response

The response will contain 1 if the media item is in the specified event ID.

NameTypeDescriptionSuccessERROR
resultINTIf the media ID is a member of the event a response of 1 will be returned. If the media item is not a member of the event the response will be empty.<result>1</result><result/>

Sample Response

Sample REST Response
http://api.filemobile.com/services/rest/events/isUserInEvent?eventId=[EVENT_ID]&userID=[USER_ID]&includeChildren=true
<?xml version="1.0" encoding="UTF-8"?>
<result>1</result>
Sample JSON Response
{
    "status": true,
    "result": 1
}

Code examples

0 comments

Be the first to comment on isUserInEvent.

Add a Comment

  • captcha