groups.isUserInGroup
Syntax
bool groups.isUserInGroup (
int groupID,
int userID,
bool includeChildren = false )
Argument Info
| Name | Type | Required | Default value | Description |
|---|
| groupID | int | Required | none | The ID of the group to search the user in. |
| userID | int | Required | none | The user ID that we are checking to see if they are in the group. |
| 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 group ID or any of the children groups. |
Response
The response will contain 1 if the media item is in the specified group ID.
| Name | Type | Description | Success | ERROR |
|---|
| result | INT | If the media ID is a member of the group a response of 1 will be returned. If the media item is not a member of the group the response will be empty. | <result>1</result> | <result/> |
Return Values
| Field | Description | Possible Values |
|---|
