Versions in this module Expand all Collapse all v1 v1.3.2 May 20, 2024 v1.3.1 Mar 17, 2024 v1.3.0 Mar 7, 2024 Changes in this version + const EmptyKey + const InputJson + const NopKey + const PartnerHost + const PublicHost + const QueryLanguage + const QuerySteamApiKey + var ApiKeyNotExistErr = errors.New("steam api key must be provided") + var PartnerEnforceHttpsErr = errors.New("partner.steam-api.com must be requested with https") + type Client struct + func New(key string) (*Client, error) + func NewWith(options ...ClientOption) (*Client, error) + func (c *Client) Get(host, url string, resultPtr any, opts ...RequestOption) (*resty.Response, error) + func (c *Client) IPlayerService() *IPlayerService + func (c *Client) IPublishedFileService() *ISteamPublishedFileService + func (c *Client) ISteamApps() *ISteamApps + func (c *Client) ISteamBroadcastService() *ISteamBroadcastService + func (c *Client) ISteamCommunity() *ISteamCommunity + func (c *Client) ISteamGameServerStats() *ISteamGameServerStats + func (c *Client) ISteamLeaderBoards() *ISteamLeaderBoards + func (c *Client) ISteamNews() *ISteamNews + func (c *Client) ISteamPublishedItemVoting() *ISteamPublishedItemVoting + func (c *Client) ISteamPublishedSearch() *ISteamPublishedItemSearch + func (c *Client) ISteamRemoteStorage() *ISteamRemoteStorage + func (c *Client) ISteamUser() *ISteamUser + func (c *Client) ISteamUserAuth() *ISteamUserAuth + func (c *Client) ISteamWebAPIUtil() *ISteamWebAPIUtil + func (c *Client) NewRequest(method, host, url string, options ...RequestOption) *Request + func (c *Client) Post(host, url string, resultPtr any, opts ...RequestOption) (*resty.Response, error) + func (c *Client) SendRequest(method, host, url string, resultPtr any, opts ...RequestOption) (*resty.Response, error) + func (c *Client) Unknown(method, host, url string, opts ...RequestOption) (steam.CommonResponse, error) + type ClientCfg struct + type ClientOption func(client *Client) + func WithClientKey(key string) ClientOption + func WithClientResty(client *resty.Client) ClientOption + func WithHttpsClient() ClientOption + type IPlayerService struct + func (i *IPlayerService) GetBadges(steamId uint, ops ...RequestOption) (steam.CommonResponse, error) + func (i *IPlayerService) GetCommunityBadgeProgress(steamId uint, badgeId int, ops ...RequestOption) (steam.CommonResponse, error) + func (i *IPlayerService) GetOwnedGames(ownGameOpt player.OwnedGamesQueryOption, ops ...RequestOption) (steam.CommonResponse, error) + func (i *IPlayerService) GetRecentlyPlayedGames(steamId uint, count uint, ops ...RequestOption) (steam.CommonResponse, error) + func (i *IPlayerService) GetSingleGamePlayTime(steamId uint, appId uint, ops ...RequestOption) (steam.CommonResponse, error) + func (i *IPlayerService) GetSteamLevel(steamId uint, ops ...RequestOption) (steam.CommonResponse, error) + type ISteamApps struct + func (i *ISteamApps) GetAppBeta(appId uint, ops ...RequestOption) (steam.CommonResponse, error) + func (i *ISteamApps) GetAppBuilds(buildsQueryOpt app.BuildsQueryOption, ops ...RequestOption) (steam.CommonResponse, error) + func (i *ISteamApps) GetAppDepotVersion(appId uint, ops ...RequestOption) (steam.CommonResponse, error) + func (i *ISteamApps) GetAppList(ops ...RequestOption) (app.PublicAppList, error) + func (i *ISteamApps) GetPartnerAppListForWebAPIKey(filter app.PartnerAppQueryFilter, ops ...RequestOption) (app.PartnerAppList, error) + func (i *ISteamApps) GetPlayersBanned(appId uint, ops ...RequestOption) (steam.CommonResponse, error) + func (i *ISteamApps) GetServerList(filter app.ServerListQueryFilter, ops ...RequestOption) (steam.CommonResponse, error) + func (i *ISteamApps) GetServersAtAddress(addr string, ops ...RequestOption) (app.ServerAddressList, error) + func (i *ISteamApps) SetAppBuildLive(updateOption app.BuildLiveUpdateOption, ops ...RequestOption) (steam.CommonResponse, error) + func (i *ISteamApps) UpToDateCheck(opt app.UpToDateCheckQueryOption, ops ...RequestOption) (app.UpToDateCheck, error) + type ISteamBroadcastService struct + func (i *ISteamBroadcastService) PostGameDataFrame(frame boradcast.DataFrame, ops ...RequestOption) (steam.CommonResponse, error) + type ISteamCommunity struct + func (i *ISteamCommunity) ReportAbuse(form community.ReportAbuseForm, ops ...RequestOption) (steam.CommonResponse, error) + type ISteamGameServerStats struct + func (i *ISteamGameServerStats) GetGameServerPlayerStatsForGame(query gameserver.GameStatQueryOpt, ops ...RequestOption) (steam.CommonResponse, error) + type ISteamLeaderBoards struct + func (i *ISteamLeaderBoards) DeleteLeaderBoard(deleteOpt leaderboard.DeleteOpt, ops ...RequestOption) (steam.CommonResponse, error) + func (i *ISteamLeaderBoards) FindOrCreateLeaderboard(createOpt leaderboard.CreateOpt, ops ...RequestOption) (steam.CommonResponse, error) + func (i *ISteamLeaderBoards) GetLeaderboardEntries(entryOpt leaderboard.EntriesQueryOpt, ops ...RequestOption) (steam.CommonResponse, error) + func (i *ISteamLeaderBoards) GetLeaderboardsForGame(appid uint, ops ...RequestOption) (steam.CommonResponse, error) + func (i *ISteamLeaderBoards) ResetLeaderboard(opt leaderboard.ResetOpt, ops ...RequestOption) (steam.CommonResponse, error) + func (i *ISteamLeaderBoards) SetLeaderboardScore(opt leaderboard.ScoreSetOpt, ops ...RequestOption) (steam.CommonResponse, error) + type ISteamNews struct + func (i *ISteamNews) GetNewsForApp(query news.AppNewsQueryOption, ops ...RequestOption) (news.AppNewsList, error) + func (i *ISteamNews) GetNewsForAppAuthed(query news.AppNewsQueryOption, ops ...RequestOption) (news.AppNewsList, error) + type ISteamPublishedFileService struct + func (i *ISteamPublishedFileService) QueryFiles(queryFileOption publishedfile.FileQueryOption, ops ...RequestOption) (publishedfile.FileList, error) + func (i *ISteamPublishedFileService) SetDeveloperMetaData(devSetOpt publishedfile.DeveloperMetaSetOption, ops ...RequestOption) (steam.CommonResponse, error) + func (i *ISteamPublishedFileService) UpdateBanStatus(banStatusUpdateOpt publishedfile.BanStatusUpdateOption, ops ...RequestOption) (steam.CommonResponse, error) + func (i *ISteamPublishedFileService) UpdateIncompatibleStatus(updateOpt publishedfile.IncompatibleStatusUpdateOption, ops ...RequestOption) (steam.CommonResponse, error) + func (i *ISteamPublishedFileService) UpdateTags(tagUpdateOpt publishedfile.TagUpdateOption, ops ...RequestOption) (steam.CommonResponse, error) + func (i *ISteamPublishedFileService) UpdateUGCBan(banUpdateOpt publishedfile.BanStatusUpdateOption, ops ...RequestOption) (steam.CommonResponse, error) + type ISteamPublishedItemSearch struct + func (i *ISteamPublishedItemSearch) RankedByPublicationOrder(rankOpt publisheditem.RankOption, ops ...RequestOption) (steam.CommonResponse, error) + func (i *ISteamPublishedItemSearch) RankedByTrend(rankOpt publisheditem.RankOption, ops ...RequestOption) (steam.CommonResponse, error) + func (i *ISteamPublishedItemSearch) RankedByVote(rankOpt publisheditem.RankOption, ops ...RequestOption) (steam.CommonResponse, error) + func (i *ISteamPublishedItemSearch) ResultSetSummary(rankOpt publisheditem.RankSummaryOption, ops ...RequestOption) (steam.CommonResponse, error) + type ISteamPublishedItemVoting struct + func (i *ISteamPublishedItemVoting) ItemVoteSummary(voteOpt publisheditem.ItemVoteOption, ops ...RequestOption) (steam.CommonResponse, error) + func (i *ISteamPublishedItemVoting) UserVoteSummary(voteOpt publisheditem.UserVoteOption, ops ...RequestOption) (steam.CommonResponse, error) + type ISteamRemoteStorage struct + func (i *ISteamRemoteStorage) EnumerateUserSubscribedFiles(enum remotestorage.EnumerateOpt, ops ...RequestOption) (steam.CommonResponse, error) + func (i *ISteamRemoteStorage) GetCollectionDetails(query remotestorage.CollectionDetailQueryOpt, ops ...RequestOption) (remotestorage.CollectionDetail, error) + func (i *ISteamRemoteStorage) GetPublishedFileDetails(query remotestorage.PublishedFileDetailQueryOpt, ops ...RequestOption) (remotestorage.PublishedFileDetail, error) + func (i *ISteamRemoteStorage) GetUGCFileDetails(query remotestorage.UgcFileDetailQueryOpt, ops ...RequestOption) (steam.CommonResponse, error) + func (i *ISteamRemoteStorage) SetUGCUsedByGC(ugc remotestorage.UgcFileUpdateOpt, ops ...RequestOption) (steam.CommonResponse, error) + func (i *ISteamRemoteStorage) SubscribePublishedFile(sub remotestorage.SubscribePublishedFileOpt, ops ...RequestOption) (steam.CommonResponse, error) + func (i *ISteamRemoteStorage) UnSubscribePublishedFile(unsub remotestorage.UnSubscribePublishedFileOpt, ops ...RequestOption) (steam.CommonResponse, error) + type ISteamUser struct + func (i *ISteamUser) CheckAppOwnership(ids steam.SteamAppId, ops ...RequestOption) (user.AppOwnershipList, error) + func (i *ISteamUser) GetAppPriceInfo(steamId uint, appIds string, ops ...RequestOption) (steam.CommonResponse, error) + func (i *ISteamUser) GetDeletedSteamIds(rowVersion uint, ops ...RequestOption) (steam.CommonResponse, error) + func (i *ISteamUser) GetFriendList(relation user.FriendListQueryOption, ops ...RequestOption) (steam.CommonResponse, error) + func (i *ISteamUser) GetPlayerBans(steamids string, ops ...RequestOption) (steam.CommonResponse, error) + func (i *ISteamUser) GetPlayerSummaries(steamids string, ops ...RequestOption) (user.PlayerSummaryList, error) + func (i *ISteamUser) GetPublisherAppOwnership(steamId uint, ops ...RequestOption) (user.PublisherAppOwnershipList, error) + func (i *ISteamUser) GetPublisherAppOwnershipChanges(chaneQueryOption user.PublisherAppOwnershipChangeQueryOption, ...) (user.AppOwnershipChanges, error) + func (i *ISteamUser) GetUserGroupList(steamId uint, ops ...RequestOption) (steam.CommonResponse, error) + func (i *ISteamUser) ResolveVanityURL(urlResolve user.ResolveVanityUrlQueryOption, ops ...RequestOption) (steam.CommonResponse, error) + type ISteamUserAuth struct + func (i *ISteamUserAuth) AuthenticateUser(authenticateOpt user.AuthenticateOpt, ops ...RequestOption) (steam.CommonResponse, error) + func (i *ISteamUserAuth) AuthenticateUserTicket(ticketAuthenticateOpt user.TicketAuthenticateOpt, ops ...RequestOption) (steam.CommonResponse, error) + type ISteamWebAPIUtil struct + func (i *ISteamWebAPIUtil) GetServerInfo(ops ...RequestOption) (webapiutil.ServerInfo, error) + func (i *ISteamWebAPIUtil) GetSupportedAPIList(ops ...RequestOption) (webapiutil.SteamApiList, error) + type Request struct + Body any + FormData map[string]any + Header http.Header + Host string + Method string + QueryForm map[string]any + Url string + func (r *Request) Attach(req *resty.Request) + func (r *Request) FormEscaped(form map[string]any) map[string]string + func (r *Request) FullURL() string + func (r *Request) Send() (*resty.Response, error) + type RequestOption func(request *Request) + func WithAPIKey(key string) RequestOption + func WithBody(body any) RequestOption + func WithFormData(formdata any) RequestOption + func WithHeader(header http.Header) RequestOption + func WithHost(host string) RequestOption + func WithInputJson(input any) RequestOption + func WithLanguage(language string) RequestOption + func WithMethod(method string) RequestOption + func WithQueryForm(query any) RequestOption + func WithQueryMap(query map[string]any) RequestOption + func WithRequest(fn func(r *resty.Request)) RequestOption + func WithURL(url string) RequestOption
Go to main page