events.isUserInEvent
Syntax
bool events.isUserInEvent (
int eventID,
int userID,
bool includeChildren = false )
Argument Info
| Name | Type | Required | Default value | Description |
|---|
| eventID | int | Required | none | The event ID to check if the user is a member of. |
| userID | int | Required | none | The user ID that we are checking to see if they are in the event. |
| includeChildren | bool | Optional | false | By 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.
| Name | Type | Description | Success | ERROR |
|---|
| result | INT | If 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/> |
Return Values
| Field | Description | Possible Values |
|---|
