summaryrefslogtreecommitdiffstats
path: root/vendor/github.com/Philipp15b/go-steam/trade/doc.go
diff options
context:
space:
mode:
authorWim <wim@42.be>2018-08-06 21:47:05 +0200
committerWim <wim@42.be>2018-08-06 21:47:05 +0200
commit51062863a5c34d81e296cf15c61140911037cf3b (patch)
tree9b5e044672486326c7a0ca8fb26430f37bf4d83c /vendor/github.com/Philipp15b/go-steam/trade/doc.go
parent4fb4b7aa6c02a54db8ad8dd98e4d321396926c0d (diff)
downloadmatterbridge-msglm-51062863a5c34d81e296cf15c61140911037cf3b.tar.gz
matterbridge-msglm-51062863a5c34d81e296cf15c61140911037cf3b.tar.bz2
matterbridge-msglm-51062863a5c34d81e296cf15c61140911037cf3b.zip
Use mod vendor for vendored directory (backwards compatible)
Diffstat (limited to 'vendor/github.com/Philipp15b/go-steam/trade/doc.go')
-rw-r--r--vendor/github.com/Philipp15b/go-steam/trade/doc.go40
1 files changed, 0 insertions, 40 deletions
diff --git a/vendor/github.com/Philipp15b/go-steam/trade/doc.go b/vendor/github.com/Philipp15b/go-steam/trade/doc.go
deleted file mode 100644
index 549ad47d..00000000
--- a/vendor/github.com/Philipp15b/go-steam/trade/doc.go
+++ /dev/null
@@ -1,40 +0,0 @@
-/*
-Allows automation of Steam Trading.
-
-Usage
-
-Like go-steam, this package is event-based. Call Poll() until the trade has ended, that is until the TradeEndedEvent is emitted.
-
- // After receiving the steam.TradeSessionStartEvent
- t := trade.New(sessionIdCookie, steamLoginCookie, steamLoginSecure, event.Other)
- for {
- eventList, err := t.Poll()
- if err != nil {
- // error handling here
- continue
- }
- for _, event := range eventList {
- switch e := event.(type) {
- case *trade.ChatEvent:
- // respond to any chat message
- t.Chat("Trading is awesome!")
- case *trade.TradeEndedEvent:
- return
- // other event handlers here
- }
- }
- }
-
-You can either log into steamcommunity.com and use the values of the `sessionId` and `steamLogin` cookies,
-or use go-steam and after logging in with client.Web.LogOn() and receiving the WebLoggedOnEvent use the `SessionId`
-and `SteamLogin` fields of steam.Web for the respective cookies.
-
-It is important that there is no delay between the Poll() calls greater than the timeout of the Steam client
-(currently five seconds before the trade partner sees a warning) or the trade will be closed automatically by Steam.
-
-Notes
-
-All method calls to Steam APIs are blocking. This packages' and its subpackages' types are not thread-safe and no calls to any method of the same
-trade instance may be done concurrently except when otherwise noted.
-*/
-package trade