Skip to content

Clarified instantiating with several Steam IDs #72

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 19, 2018
Merged

Clarified instantiating with several Steam IDs #72

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
41a0810
Clarified instantiating with several Steam IDs
ilumos Apr 15, 2018
770b2b2
Merge branch 'master' into patch-1
stygiansabyss Jul 19, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,7 @@ appId| int | The game to check for | Yes |
### User
The [User](https://developer.valvesoftware.com/wiki/Steam_Web_API#GetFriendList_.28v0001.29) WebAPI call is used to get details about the user specifically.

When instantiating the user class, you are required to pass a steamID or Steam community ID.
When instantiating the user class, you are required to pass at least one steamId or steam community ID.

```php
Steam::user($steamId)
Expand All @@ -198,7 +198,7 @@ displayName| string | The display name to get the steam ID for. In `http://ste
> Example Output: [ResolveVanityURL](./examples/user/ResolveVanityURL.txt)

#### GetPlayerSummaries
This will return details on the user.
This will return details on one or more users.

##### Arguments

Expand All @@ -207,7 +207,13 @@ Name | Type | Description | Required | Default
steamId| int[] | An array of (or singular) steam ID(s) to get details for | No | Steam ID passed to user()

```php
// One user
$steamId = 76561197960287930;
$player = Steam::user($steamId)->GetPlayerSummaries()[0];

// Several users
$steamIds [76561197960287930, 76561197968575517]
$players = Steam::user($steamIds)->GetPlayerSummaries();
```

> Example Output: [GetPlayerSummaries](./examples/user/GetPlayerSummaries.txt)
Expand Down