mirror of
https://github.com/DoctorMcKay/node-steamcommunity.git
synced 2026-08-19 13:13:28 +08:00
Updated CSteamGroup (markdown)
@@ -51,15 +51,27 @@ How many group members were online on Steam when `getSteamGroup` was called
|
||||
|
||||
Returns a URL where you can download this group's avatar.
|
||||
|
||||
### getMembers(callback)
|
||||
### getMembers([addresses, ]callback)
|
||||
- `addresses` - Optional. An array of IP addresses (in `x.x.x.x` format) that will be rotated between when paging through the results. See below for details.
|
||||
- `callback` - Called when the member list is available
|
||||
- `err` - `null` on success, an `Error` object on failure
|
||||
- `members` - An array of `SteamID` objects
|
||||
|
||||
**Non-object method name: `getGroupMembers`**
|
||||
|
||||
**v3.5.0 or later is required to use the `addresses` argument.**
|
||||
|
||||
Retrieves a list of all users in this group. For large groups this could take around 30 seconds, possibly longer.
|
||||
|
||||
Steam returns at most 1000 users per page. Therefore, `node-steamcommunity` will need to make ceil(totalMembers / 1000) HTTP requests to fulfill this request. steamcommunity.com will start rate-limiting us after around 60 requests. If you supply an array of IP addresses which are accessible to this machine as the `addresses` argument, then `node-steamcommunity` will rotate between them for each request.
|
||||
|
||||
**Important:** If using non-object methods, then you'll need to use differently-named methods depending on whether or not you want to use `addresses`.
|
||||
|
||||
- To **not** use `addresses`:
|
||||
- `community.getGroupMembers(groupID, callback)`
|
||||
- To use `addresses`:
|
||||
- `dcommunity.getGroupMembersEx(groupID, addresses, callback)`
|
||||
|
||||
### join([callback])
|
||||
- `callback` - Called when the request completes
|
||||
- `err` - `null` on success, an `Error` object on failure
|
||||
|
||||
Reference in New Issue
Block a user