API Reference

Geo.getGroupsFromArea

This function returns groups for a square area defined by the $northEast and $southWest tips of the square.

Syntax

mixed geo.getGroupsFromArea ( int vhost, array northEast, array southWest, int moderationStatus = false )

Arguments

NameTypeRequiredDefault valueDescription
vhostintRequirednoneThe vhost of the application.
northEastarrayRequirednoneThe north-east (upper-right) point of the square that defines the area for the groups. Along with $southWest, is provides the co-ordinates for the area that is to show the users. Examle: $northEast[0] => 62.865220228976895, $northEast[1] => -52.44921875
southWestarrayRequirednoneThe south-west (lower-left) point of the square that defines the area for the groups. Along with $northEast, is provides the co-ordinates for the area that is to show the users. Examle: $southWest[0] => 35.08404808848904, $southWest[1] => -131.55078125
moderationStatusintOptionalfalseThe moderationstatus of the groups to be displayed. Possible values: 1 (unmoderated), 2 (approved), 3 (not denied), 4 (denied)

Response

Below are the fields available in the returned array.

NameTypeDescription
idINTThe group id.
nameSTRINGThe group name.
logoINTThe id of the media set as the logo for the group.
memberCountINTThe number of members in the group.
geo_latitudeFLOATThe group's geographical latitude. i.e.: 40.775729609144044
geo_longitudeFLOATThe group's geographical longitude. i.e.: -84.44921875
addressINTThe address of the group.

Sample Response

Code examples

0 comments

Be the first to comment on getGroupsFromArea.

Add a Comment

  • captcha