buildwebapi/builded_webapi

Search:
Group by:

Author:levshx
Generator:https://github.com/levshx/nim-steam/
Date:2022-07-23T13:29:09Z

Types

AsyncSteamWebAPI = object
  IClientStats_1046930*: AsyncIClientStats_1046930
  IGCVersion_1046930*: AsyncIGCVersion_1046930
  IGCVersion_1269260*: AsyncIGCVersion_1269260
  IGCVersion_205790*: AsyncIGCVersion_205790
  IGCVersion_440*: AsyncIGCVersion_440
  IGCVersion_570*: AsyncIGCVersion_570
  IGCVersion_583950*: AsyncIGCVersion_583950
  IGCVersion_730*: AsyncIGCVersion_730
  IPortal2Leaderboards_620*: AsyncIPortal2Leaderboards_620
  ISteamApps*: AsyncISteamApps
  ISteamBroadcast*: AsyncISteamBroadcast
  ISteamDirectory*: AsyncISteamDirectory
  ISteamNews*: AsyncISteamNews
  ISteamRemoteStorage*: AsyncISteamRemoteStorage
  ISteamUserAuth*: AsyncISteamUserAuth
  ISteamUserOAuth*: AsyncISteamUserOAuth
  ISteamUserStats*: AsyncISteamUserStats
  ISteamWebAPIUtil*: AsyncISteamWebAPIUtil
  ISteamWebUserPresenceOAuth*: AsyncISteamWebUserPresenceOAuth
  ITFSystem_440*: AsyncITFSystem_440
  IBroadcastService*: AsyncIBroadcastService
  IContentServerDirectoryService*: AsyncIContentServerDirectoryService
  IPublishedFileService*: AsyncIPublishedFileService
  IPlayerService*: AsyncIPlayerService
  IGameNotificationsService*: AsyncIGameNotificationsService
  IHelpRequestLogsService*: AsyncIHelpRequestLogsService
Async steam WebAPI client
Message = string
Rawbinary = string
SteamWebAPI = object
  IClientStats_1046930*: IClientStats_1046930
  IGCVersion_1046930*: IGCVersion_1046930
  IGCVersion_1269260*: IGCVersion_1269260
  IGCVersion_205790*: IGCVersion_205790
  IGCVersion_440*: IGCVersion_440
  IGCVersion_570*: IGCVersion_570
  IGCVersion_583950*: IGCVersion_583950
  IGCVersion_730*: IGCVersion_730
  IPortal2Leaderboards_620*: IPortal2Leaderboards_620
  ISteamApps*: ISteamApps
  ISteamBroadcast*: ISteamBroadcast
  ISteamDirectory*: ISteamDirectory
  ISteamNews*: ISteamNews
  ISteamRemoteStorage*: ISteamRemoteStorage
  ISteamUserAuth*: ISteamUserAuth
  ISteamUserOAuth*: ISteamUserOAuth
  ISteamUserStats*: ISteamUserStats
  ISteamWebAPIUtil*: ISteamWebAPIUtil
  ISteamWebUserPresenceOAuth*: ISteamWebUserPresenceOAuth
  ITFSystem_440*: ITFSystem_440
  IBroadcastService*: IBroadcastService
  IContentServerDirectoryService*: IContentServerDirectoryService
  IPublishedFileService*: IPublishedFileService
  IPlayerService*: IPlayerService
  IGameNotificationsService*: IGameNotificationsService
  IHelpRequestLogsService*: IHelpRequestLogsService
Sync steam WebAPI client

Consts

WEBAPI_BASE_URL = "https://api.steampowered.com/"
Steam API URL (SSL).

Procs

proc AuthenticateUserV1(interfacename: AsyncISteamUserAuth;
                        steamid = none(uint64); sessionkey = none(Rawbinary);
                        encrypted_loginkey = none(Rawbinary)): Future[string] {.
    ...stackTrace: false, raises: [Exception, ValueError],
    tags: [RootEffect, ReadDirEffect, ReadEnvEffect, ReadIOEffect, TimeEffect],
    forbids: [].}
steamid : uint64 — (Required) Should be the users steamid, unencrypted. sessionkey : Rawbinary — (Required) Should be a 32 byte random blob of data, which is then encrypted with RSA using the Steam system's public key. Randomness is important here for security. encrypted_loginkey : Rawbinary — (Required) Should be the users hashed loginkey, AES encrypted with the sessionkey.
proc AuthenticateUserV1(interfacename: ISteamUserAuth; steamid = none(uint64);
                        sessionkey = none(Rawbinary);
                        encrypted_loginkey = none(Rawbinary)): string {....raises: [
    LibraryError, SslError, Exception, IOError, OSError, KeyError, ValueError,
    HttpRequestError, TimeoutError, ProtocolError], tags: [RootEffect,
    ReadDirEffect, ReadEnvEffect, ReadIOEffect, WriteIOEffect, TimeEffect],
    forbids: [].}
steamid : uint64 — (Required) Should be the users steamid, unencrypted. sessionkey : Rawbinary — (Required) Should be a 32 byte random blob of data, which is then encrypted with RSA using the Steam system's public key. Randomness is important here for security. encrypted_loginkey : Rawbinary — (Required) Should be the users hashed loginkey, AES encrypted with the sessionkey.
proc GetApplicationLogDemandV1(interfacename: AsyncIHelpRequestLogsService;
                               appid = none(uint32)): Future[string] {.
    ...stackTrace: false, raises: [Exception, ValueError],
    tags: [RootEffect, ReadDirEffect, ReadEnvEffect, ReadIOEffect, TimeEffect],
    forbids: [].}
Returns whether the server would like the user to upload logs appid : uint32 — (Required)
proc GetApplicationLogDemandV1(interfacename: IHelpRequestLogsService;
                               appid = none(uint32)): string {....raises: [
    LibraryError, SslError, Exception, IOError, OSError, KeyError, ValueError,
    HttpRequestError, TimeoutError, ProtocolError], tags: [RootEffect,
    ReadDirEffect, ReadEnvEffect, ReadIOEffect, WriteIOEffect, TimeEffect],
    forbids: [].}
Returns whether the server would like the user to upload logs appid : uint32 — (Required)
proc GetAppListV1(interfacename: AsyncISteamApps): Future[string] {.
    ...stackTrace: false, raises: [Exception, ValueError],
    tags: [RootEffect, ReadDirEffect, ReadEnvEffect, ReadIOEffect, TimeEffect],
    forbids: [].}
HTTP METHOD GET
proc GetAppListV1(interfacename: ISteamApps): string {....raises: [LibraryError,
    SslError, Exception, IOError, OSError, ValueError, HttpRequestError,
    TimeoutError, ProtocolError, KeyError], tags: [RootEffect, ReadDirEffect,
    ReadEnvEffect, ReadIOEffect, WriteIOEffect, TimeEffect], forbids: [].}
HTTP METHOD GET
proc GetAppListV2(interfacename: AsyncISteamApps): Future[string] {.
    ...stackTrace: false, raises: [Exception, ValueError],
    tags: [RootEffect, ReadDirEffect, ReadEnvEffect, ReadIOEffect, TimeEffect],
    forbids: [].}
HTTP METHOD GET
proc GetAppListV2(interfacename: ISteamApps): string {....raises: [LibraryError,
    SslError, Exception, IOError, OSError, ValueError, HttpRequestError,
    TimeoutError, ProtocolError, KeyError], tags: [RootEffect, ReadDirEffect,
    ReadEnvEffect, ReadIOEffect, WriteIOEffect, TimeEffect], forbids: [].}
HTTP METHOD GET
proc GetBucketizedDataV1(interfacename: AsyncIPortal2Leaderboards_620;
                         leaderboardName = none(string)): Future[string] {.
    ...stackTrace: false, raises: [Exception, ValueError],
    tags: [RootEffect, ReadDirEffect, ReadEnvEffect, ReadIOEffect, TimeEffect],
    forbids: [].}
leaderboardName : string — (Required) The leaderboard name to fetch data for.
proc GetBucketizedDataV1(interfacename: IPortal2Leaderboards_620;
                         leaderboardName = none(string)): string {....raises: [
    LibraryError, SslError, Exception, IOError, OSError, ValueError,
    HttpRequestError, TimeoutError, ProtocolError, KeyError], tags: [RootEffect,
    ReadDirEffect, ReadEnvEffect, ReadIOEffect, WriteIOEffect, TimeEffect],
    forbids: [].}
leaderboardName : string — (Required) The leaderboard name to fetch data for.
proc GetClientUpdateHostsV1(interfacename: AsyncIContentServerDirectoryService;
                            cached_signature = none(string)): Future[string] {.
    ...stackTrace: false, raises: [Exception, ValueError],
    tags: [RootEffect, ReadDirEffect, ReadEnvEffect, ReadIOEffect, TimeEffect],
    forbids: [].}
cached_signature : string — (Required)
proc GetClientUpdateHostsV1(interfacename: IContentServerDirectoryService;
                            cached_signature = none(string)): string {....raises: [
    LibraryError, SslError, Exception, IOError, OSError, ValueError,
    HttpRequestError, TimeoutError, ProtocolError, KeyError], tags: [RootEffect,
    ReadDirEffect, ReadEnvEffect, ReadIOEffect, WriteIOEffect, TimeEffect],
    forbids: [].}
cached_signature : string — (Required)
proc GetClientVersionV1(interfacename: AsyncIGCVersion_440): Future[string] {.
    ...stackTrace: false, raises: [Exception, ValueError],
    tags: [RootEffect, ReadDirEffect, ReadEnvEffect, ReadIOEffect, TimeEffect],
    forbids: [].}
HTTP METHOD GET
proc GetClientVersionV1(interfacename: AsyncIGCVersion_570): Future[string] {.
    ...stackTrace: false, raises: [Exception, ValueError],
    tags: [RootEffect, ReadDirEffect, ReadEnvEffect, ReadIOEffect, TimeEffect],
    forbids: [].}
HTTP METHOD GET
proc GetClientVersionV1(interfacename: AsyncIGCVersion_205790): Future[string] {.
    ...stackTrace: false, raises: [Exception, ValueError],
    tags: [RootEffect, ReadDirEffect, ReadEnvEffect, ReadIOEffect, TimeEffect],
    forbids: [].}
HTTP METHOD GET
proc GetClientVersionV1(interfacename: AsyncIGCVersion_583950): Future[string] {.
    ...stackTrace: false, raises: [Exception, ValueError],
    tags: [RootEffect, ReadDirEffect, ReadEnvEffect, ReadIOEffect, TimeEffect],
    forbids: [].}
HTTP METHOD GET
proc GetClientVersionV1(interfacename: AsyncIGCVersion_1046930): Future[string] {.
    ...stackTrace: false, raises: [Exception, ValueError],
    tags: [RootEffect, ReadDirEffect, ReadEnvEffect, ReadIOEffect, TimeEffect],
    forbids: [].}
HTTP METHOD GET
proc GetClientVersionV1(interfacename: AsyncIGCVersion_1269260): Future[string] {.
    ...stackTrace: false, raises: [Exception, ValueError],
    tags: [RootEffect, ReadDirEffect, ReadEnvEffect, ReadIOEffect, TimeEffect],
    forbids: [].}
HTTP METHOD GET
proc GetClientVersionV1(interfacename: IGCVersion_440): string {....raises: [
    LibraryError, SslError, Exception, IOError, OSError, ValueError,
    HttpRequestError, TimeoutError, ProtocolError, KeyError], tags: [RootEffect,
    ReadDirEffect, ReadEnvEffect, ReadIOEffect, WriteIOEffect, TimeEffect],
    forbids: [].}
HTTP METHOD GET
proc GetClientVersionV1(interfacename: IGCVersion_570): string {....raises: [
    LibraryError, SslError, Exception, IOError, OSError, ValueError,
    HttpRequestError, TimeoutError, ProtocolError, KeyError], tags: [RootEffect,
    ReadDirEffect, ReadEnvEffect, ReadIOEffect, WriteIOEffect, TimeEffect],
    forbids: [].}
HTTP METHOD GET
proc GetClientVersionV1(interfacename: IGCVersion_205790): string {....raises: [
    LibraryError, SslError, Exception, IOError, OSError, ValueError,
    HttpRequestError, TimeoutError, ProtocolError, KeyError], tags: [RootEffect,
    ReadDirEffect, ReadEnvEffect, ReadIOEffect, WriteIOEffect, TimeEffect],
    forbids: [].}
HTTP METHOD GET
proc GetClientVersionV1(interfacename: IGCVersion_583950): string {....raises: [
    LibraryError, SslError, Exception, IOError, OSError, ValueError,
    HttpRequestError, TimeoutError, ProtocolError, KeyError], tags: [RootEffect,
    ReadDirEffect, ReadEnvEffect, ReadIOEffect, WriteIOEffect, TimeEffect],
    forbids: [].}
HTTP METHOD GET
proc GetClientVersionV1(interfacename: IGCVersion_1046930): string {....raises: [
    LibraryError, SslError, Exception, IOError, OSError, ValueError,
    HttpRequestError, TimeoutError, ProtocolError, KeyError], tags: [RootEffect,
    ReadDirEffect, ReadEnvEffect, ReadIOEffect, WriteIOEffect, TimeEffect],
    forbids: [].}
HTTP METHOD GET
proc GetClientVersionV1(interfacename: IGCVersion_1269260): string {....raises: [
    LibraryError, SslError, Exception, IOError, OSError, ValueError,
    HttpRequestError, TimeoutError, ProtocolError, KeyError], tags: [RootEffect,
    ReadDirEffect, ReadEnvEffect, ReadIOEffect, WriteIOEffect, TimeEffect],
    forbids: [].}
HTTP METHOD GET
proc GetCMListForConnectV1(interfacename: AsyncISteamDirectory;
                           cellid = none(uint32); cmtype = none(string);
                           realm = none(string); maxcount = none(uint32)): Future[
    string] {....stackTrace: false, raises: [Exception, ValueError], tags: [
    RootEffect, ReadDirEffect, ReadEnvEffect, ReadIOEffect, TimeEffect],
              forbids: [].}
cellid : uint32 — (Optional) Client's Steam cell ID, uses IP location if blank cmtype : string — (Optional) Optional CM type filter realm : string — (Optional) Optional Steam Realm filter maxcount : uint32 — (Optional) Max number of servers to return
proc GetCMListForConnectV1(interfacename: ISteamDirectory;
                           cellid = none(uint32); cmtype = none(string);
                           realm = none(string); maxcount = none(uint32)): string {....raises: [
    LibraryError, SslError, Exception, IOError, OSError, ValueError,
    HttpRequestError, TimeoutError, ProtocolError, KeyError], tags: [RootEffect,
    ReadDirEffect, ReadEnvEffect, ReadIOEffect, WriteIOEffect, TimeEffect],
    forbids: [].}
cellid : uint32 — (Optional) Client's Steam cell ID, uses IP location if blank cmtype : string — (Optional) Optional CM type filter realm : string — (Optional) Optional Steam Realm filter maxcount : uint32 — (Optional) Max number of servers to return
proc GetCMListV1(interfacename: AsyncISteamDirectory; cellid = none(uint32);
                 maxcount = none(uint32)): Future[string] {....stackTrace: false,
    raises: [Exception, ValueError],
    tags: [RootEffect, ReadDirEffect, ReadEnvEffect, ReadIOEffect, TimeEffect],
    forbids: [].}
cellid : uint32 — (Required) Client's Steam cell ID maxcount : uint32 — (Optional) Max number of servers to return
proc GetCMListV1(interfacename: ISteamDirectory; cellid = none(uint32);
                 maxcount = none(uint32)): string {....raises: [LibraryError,
    SslError, Exception, IOError, OSError, ValueError, HttpRequestError,
    TimeoutError, ProtocolError, KeyError], tags: [RootEffect, ReadDirEffect,
    ReadEnvEffect, ReadIOEffect, WriteIOEffect, TimeEffect], forbids: [].}
cellid : uint32 — (Required) Client's Steam cell ID maxcount : uint32 — (Optional) Max number of servers to return
proc GetCollectionDetailsV1(interfacename: AsyncISteamRemoteStorage;
                            collectioncount = none(uint32);
                            publishedfileids = none(seq[uint64])): Future[string] {.
    ...stackTrace: false, raises: [Exception, ValueError],
    tags: [RootEffect, ReadDirEffect, ReadEnvEffect, ReadIOEffect, TimeEffect],
    forbids: [].}
collectioncount : uint32 — (Required) Number of collections being requested publishedfileids : sequint64 — (Required) collection ids to get the details for
proc GetCollectionDetailsV1(interfacename: ISteamRemoteStorage;
                            collectioncount = none(uint32);
                            publishedfileids = none(seq[uint64])): string {....raises: [
    LibraryError, SslError, Exception, IOError, OSError, KeyError, ValueError,
    HttpRequestError, TimeoutError, ProtocolError], tags: [RootEffect,
    ReadDirEffect, ReadEnvEffect, ReadIOEffect, WriteIOEffect, TimeEffect],
    forbids: [].}
collectioncount : uint32 — (Required) Number of collections being requested publishedfileids : sequint64 — (Required) collection ids to get the details for
proc GetDepotPatchInfoV1(interfacename: AsyncIContentServerDirectoryService;
                         appid = none(uint32); depotid = none(uint32);
                         source_manifestid = none(uint64);
                         target_manifestid = none(uint64)): Future[string] {.
    ...stackTrace: false, raises: [Exception, ValueError],
    tags: [RootEffect, ReadDirEffect, ReadEnvEffect, ReadIOEffect, TimeEffect],
    forbids: [].}
appid : uint32 — (Required) depotid : uint32 — (Required) source_manifestid : uint64 — (Required) target_manifestid : uint64 — (Required)
proc GetDepotPatchInfoV1(interfacename: IContentServerDirectoryService;
                         appid = none(uint32); depotid = none(uint32);
                         source_manifestid = none(uint64);
                         target_manifestid = none(uint64)): string {....raises: [
    LibraryError, SslError, Exception, IOError, OSError, ValueError,
    HttpRequestError, TimeoutError, ProtocolError, KeyError], tags: [RootEffect,
    ReadDirEffect, ReadEnvEffect, ReadIOEffect, WriteIOEffect, TimeEffect],
    forbids: [].}
appid : uint32 — (Required) depotid : uint32 — (Required) source_manifestid : uint64 — (Required) target_manifestid : uint64 — (Required)
proc GetGlobalAchievementPercentagesForAppV1(
    interfacename: AsyncISteamUserStats; gameid = none(uint64)): Future[string] {.
    ...stackTrace: false, raises: [Exception, ValueError],
    tags: [RootEffect, ReadDirEffect, ReadEnvEffect, ReadIOEffect, TimeEffect],
    forbids: [].}
gameid : uint64 — (Required) GameID to retrieve the achievement percentages for
proc GetGlobalAchievementPercentagesForAppV1(interfacename: ISteamUserStats;
    gameid = none(uint64)): string {....raises: [LibraryError, SslError, Exception,
    IOError, OSError, ValueError, HttpRequestError, TimeoutError, ProtocolError,
    KeyError], tags: [RootEffect, ReadDirEffect, ReadEnvEffect, ReadIOEffect,
                      WriteIOEffect, TimeEffect], forbids: [].}
gameid : uint64 — (Required) GameID to retrieve the achievement percentages for
proc GetGlobalAchievementPercentagesForAppV2(
    interfacename: AsyncISteamUserStats; gameid = none(uint64)): Future[string] {.
    ...stackTrace: false, raises: [Exception, ValueError],
    tags: [RootEffect, ReadDirEffect, ReadEnvEffect, ReadIOEffect, TimeEffect],
    forbids: [].}
gameid : uint64 — (Required) GameID to retrieve the achievement percentages for
proc GetGlobalAchievementPercentagesForAppV2(interfacename: ISteamUserStats;
    gameid = none(uint64)): string {....raises: [LibraryError, SslError, Exception,
    IOError, OSError, ValueError, HttpRequestError, TimeoutError, ProtocolError,
    KeyError], tags: [RootEffect, ReadDirEffect, ReadEnvEffect, ReadIOEffect,
                      WriteIOEffect, TimeEffect], forbids: [].}
gameid : uint64 — (Required) GameID to retrieve the achievement percentages for
proc GetGlobalStatsForGameV1(interfacename: AsyncISteamUserStats;
                             appid = none(uint32); count = none(uint32);
                             name = none(seq[string]); startdate = none(uint32);
                             enddate = none(uint32)): Future[string] {.
    ...stackTrace: false, raises: [Exception, ValueError],
    tags: [RootEffect, ReadDirEffect, ReadEnvEffect, ReadIOEffect, TimeEffect],
    forbids: [].}
appid : uint32 — (Required) AppID that we're getting global stats for count : uint32 — (Required) Number of stats get data for name : seqstring — (Required) Names of stat to get data for startdate : uint32 — (Optional) Start date for daily totals (unix epoch timestamp) enddate : uint32 — (Optional) End date for daily totals (unix epoch timestamp)
proc GetGlobalStatsForGameV1(interfacename: ISteamUserStats;
                             appid = none(uint32); count = none(uint32);
                             name = none(seq[string]); startdate = none(uint32);
                             enddate = none(uint32)): string {....raises: [
    LibraryError, SslError, Exception, IOError, OSError, ValueError,
    HttpRequestError, TimeoutError, ProtocolError, KeyError], tags: [RootEffect,
    ReadDirEffect, ReadEnvEffect, ReadIOEffect, WriteIOEffect, TimeEffect],
    forbids: [].}
appid : uint32 — (Required) AppID that we're getting global stats for count : uint32 — (Required) Number of stats get data for name : seqstring — (Required) Names of stat to get data for startdate : uint32 — (Optional) Start date for daily totals (unix epoch timestamp) enddate : uint32 — (Optional) End date for daily totals (unix epoch timestamp)
proc GetNewsForAppV1(interfacename: AsyncISteamNews; appid = none(uint32);
                     maxlength = none(uint32); enddate = none(uint32);
                     count = none(uint32); tags = none(string)): Future[string] {.
    ...stackTrace: false, raises: [Exception, ValueError],
    tags: [RootEffect, ReadDirEffect, ReadEnvEffect, ReadIOEffect, TimeEffect],
    forbids: [].}
appid : uint32 — (Required) AppID to retrieve news for maxlength : uint32 — (Optional) Maximum length for the content to return, if this is 0 the full content is returned, if it's less then a blurb is generated to fit. enddate : uint32 — (Optional) Retrieve posts earlier than this date (unix epoch timestamp) count : uint32 — (Optional) # of posts to retrieve (default 20) tags : string — (Optional) Comma-separated list of tags to filter by (e.g. 'patchnodes')
proc GetNewsForAppV1(interfacename: ISteamNews; appid = none(uint32);
                     maxlength = none(uint32); enddate = none(uint32);
                     count = none(uint32); tags = none(string)): string {....raises: [
    LibraryError, SslError, Exception, IOError, OSError, ValueError,
    HttpRequestError, TimeoutError, ProtocolError, KeyError], tags: [RootEffect,
    ReadDirEffect, ReadEnvEffect, ReadIOEffect, WriteIOEffect, TimeEffect],
    forbids: [].}
appid : uint32 — (Required) AppID to retrieve news for maxlength : uint32 — (Optional) Maximum length for the content to return, if this is 0 the full content is returned, if it's less then a blurb is generated to fit. enddate : uint32 — (Optional) Retrieve posts earlier than this date (unix epoch timestamp) count : uint32 — (Optional) # of posts to retrieve (default 20) tags : string — (Optional) Comma-separated list of tags to filter by (e.g. 'patchnodes')
proc GetNewsForAppV2(interfacename: AsyncISteamNews; appid = none(uint32);
                     maxlength = none(uint32); enddate = none(uint32);
                     count = none(uint32); feeds = none(string);
                     tags = none(string)): Future[string] {....stackTrace: false,
    raises: [Exception, ValueError],
    tags: [RootEffect, ReadDirEffect, ReadEnvEffect, ReadIOEffect, TimeEffect],
    forbids: [].}
appid : uint32 — (Required) AppID to retrieve news for maxlength : uint32 — (Optional) Maximum length for the content to return, if this is 0 the full content is returned, if it's less then a blurb is generated to fit. enddate : uint32 — (Optional) Retrieve posts earlier than this date (unix epoch timestamp) count : uint32 — (Optional) # of posts to retrieve (default 20) feeds : string — (Optional) Comma-separated list of feed names to return news for tags : string — (Optional) Comma-separated list of tags to filter by (e.g. 'patchnodes')
proc GetNewsForAppV2(interfacename: ISteamNews; appid = none(uint32);
                     maxlength = none(uint32); enddate = none(uint32);
                     count = none(uint32); feeds = none(string);
                     tags = none(string)): string {....raises: [LibraryError,
    SslError, Exception, IOError, OSError, ValueError, HttpRequestError,
    TimeoutError, ProtocolError, KeyError], tags: [RootEffect, ReadDirEffect,
    ReadEnvEffect, ReadIOEffect, WriteIOEffect, TimeEffect], forbids: [].}
appid : uint32 — (Required) AppID to retrieve news for maxlength : uint32 — (Optional) Maximum length for the content to return, if this is 0 the full content is returned, if it's less then a blurb is generated to fit. enddate : uint32 — (Optional) Retrieve posts earlier than this date (unix epoch timestamp) count : uint32 — (Optional) # of posts to retrieve (default 20) feeds : string — (Optional) Comma-separated list of feed names to return news for tags : string — (Optional) Comma-separated list of tags to filter by (e.g. 'patchnodes')
proc GetNumberOfCurrentPlayersV1(interfacename: AsyncISteamUserStats;
                                 appid = none(uint32)): Future[string] {.
    ...stackTrace: false, raises: [Exception, ValueError],
    tags: [RootEffect, ReadDirEffect, ReadEnvEffect, ReadIOEffect, TimeEffect],
    forbids: [].}
appid : uint32 — (Required) AppID that we're getting user count for
proc GetNumberOfCurrentPlayersV1(interfacename: ISteamUserStats;
                                 appid = none(uint32)): string {....raises: [
    LibraryError, SslError, Exception, IOError, OSError, ValueError,
    HttpRequestError, TimeoutError, ProtocolError, KeyError], tags: [RootEffect,
    ReadDirEffect, ReadEnvEffect, ReadIOEffect, WriteIOEffect, TimeEffect],
    forbids: [].}
appid : uint32 — (Required) AppID that we're getting user count for
proc GetPublishedFileDetailsV1(interfacename: AsyncISteamRemoteStorage;
                               itemcount = none(uint32);
                               publishedfileids = none(seq[uint64])): Future[
    string] {....stackTrace: false, raises: [Exception, ValueError], tags: [
    RootEffect, ReadDirEffect, ReadEnvEffect, ReadIOEffect, TimeEffect],
              forbids: [].}
itemcount : uint32 — (Required) Number of items being requested publishedfileids : sequint64 — (Required) published file id to look up
proc GetPublishedFileDetailsV1(interfacename: ISteamRemoteStorage;
                               itemcount = none(uint32);
                               publishedfileids = none(seq[uint64])): string {....raises: [
    LibraryError, SslError, Exception, IOError, OSError, KeyError, ValueError,
    HttpRequestError, TimeoutError, ProtocolError], tags: [RootEffect,
    ReadDirEffect, ReadEnvEffect, ReadIOEffect, WriteIOEffect, TimeEffect],
    forbids: [].}
itemcount : uint32 — (Required) Number of items being requested publishedfileids : sequint64 — (Required) published file id to look up
proc GetSDRConfigV1(interfacename: AsyncISteamApps; appid = none(uint32)): Future[
    string] {....stackTrace: false, raises: [Exception, ValueError], tags: [
    RootEffect, ReadDirEffect, ReadEnvEffect, ReadIOEffect, TimeEffect],
              forbids: [].}
appid : uint32 — (Required) AppID of game
proc GetSDRConfigV1(interfacename: ISteamApps; appid = none(uint32)): string {....raises: [
    LibraryError, SslError, Exception, IOError, OSError, ValueError,
    HttpRequestError, TimeoutError, ProtocolError, KeyError], tags: [RootEffect,
    ReadDirEffect, ReadEnvEffect, ReadIOEffect, WriteIOEffect, TimeEffect],
    forbids: [].}
appid : uint32 — (Required) AppID of game
proc GetServerInfoV1(interfacename: AsyncISteamWebAPIUtil): Future[string] {.
    ...stackTrace: false, raises: [Exception, ValueError],
    tags: [RootEffect, ReadDirEffect, ReadEnvEffect, ReadIOEffect, TimeEffect],
    forbids: [].}
HTTP METHOD GET
proc GetServerInfoV1(interfacename: ISteamWebAPIUtil): string {....raises: [
    LibraryError, SslError, Exception, IOError, OSError, ValueError,
    HttpRequestError, TimeoutError, ProtocolError, KeyError], tags: [RootEffect,
    ReadDirEffect, ReadEnvEffect, ReadIOEffect, WriteIOEffect, TimeEffect],
    forbids: [].}
HTTP METHOD GET
proc GetServersAtAddressV1(interfacename: AsyncISteamApps; addr = none(string)): Future[
    string] {....stackTrace: false, raises: [Exception, ValueError], tags: [
    RootEffect, ReadDirEffect, ReadEnvEffect, ReadIOEffect, TimeEffect],
              forbids: [].}
addr : string — (Required) IP or IP:queryport to list
proc GetServersAtAddressV1(interfacename: ISteamApps; addr = none(string)): string {....raises: [
    LibraryError, SslError, Exception, IOError, OSError, ValueError,
    HttpRequestError, TimeoutError, ProtocolError, KeyError], tags: [RootEffect,
    ReadDirEffect, ReadEnvEffect, ReadIOEffect, WriteIOEffect, TimeEffect],
    forbids: [].}
addr : string — (Required) IP or IP:queryport to list
proc GetServersForSteamPipeV1(interfacename: AsyncIContentServerDirectoryService;
                              cell_id = none(uint32);
                              max_servers = none(uint32);
                              ip_override = none(string);
                              launcher_type = none(int32);
                              ipv6_public = none(string)): Future[string] {.
    ...stackTrace: false, raises: [Exception, ValueError],
    tags: [RootEffect, ReadDirEffect, ReadEnvEffect, ReadIOEffect, TimeEffect],
    forbids: [].}
cell_id : uint32 — (Required) client Cell ID max_servers : uint32 — (Optional) max servers in response list ip_override : string — (Optional) client IP address launcher_type : int32 — (Optional) launcher type ipv6_public : string — (Optional) client public ipv6 address if it knows it
proc GetServersForSteamPipeV1(interfacename: IContentServerDirectoryService;
                              cell_id = none(uint32);
                              max_servers = none(uint32);
                              ip_override = none(string);
                              launcher_type = none(int32);
                              ipv6_public = none(string)): string {....raises: [
    LibraryError, SslError, Exception, IOError, OSError, ValueError,
    HttpRequestError, TimeoutError, ProtocolError, KeyError], tags: [RootEffect,
    ReadDirEffect, ReadEnvEffect, ReadIOEffect, WriteIOEffect, TimeEffect],
    forbids: [].}
cell_id : uint32 — (Required) client Cell ID max_servers : uint32 — (Optional) max servers in response list ip_override : string — (Optional) client IP address launcher_type : int32 — (Optional) launcher type ipv6_public : string — (Optional) client public ipv6 address if it knows it
proc GetServerVersionV1(interfacename: AsyncIGCVersion_440): Future[string] {.
    ...stackTrace: false, raises: [Exception, ValueError],
    tags: [RootEffect, ReadDirEffect, ReadEnvEffect, ReadIOEffect, TimeEffect],
    forbids: [].}
HTTP METHOD GET
proc GetServerVersionV1(interfacename: AsyncIGCVersion_570): Future[string] {.
    ...stackTrace: false, raises: [Exception, ValueError],
    tags: [RootEffect, ReadDirEffect, ReadEnvEffect, ReadIOEffect, TimeEffect],
    forbids: [].}
HTTP METHOD GET
proc GetServerVersionV1(interfacename: AsyncIGCVersion_730): Future[string] {.
    ...stackTrace: false, raises: [Exception, ValueError],
    tags: [RootEffect, ReadDirEffect, ReadEnvEffect, ReadIOEffect, TimeEffect],
    forbids: [].}
HTTP METHOD GET
proc GetServerVersionV1(interfacename: AsyncIGCVersion_205790): Future[string] {.
    ...stackTrace: false, raises: [Exception, ValueError],
    tags: [RootEffect, ReadDirEffect, ReadEnvEffect, ReadIOEffect, TimeEffect],
    forbids: [].}
HTTP METHOD GET
proc GetServerVersionV1(interfacename: AsyncIGCVersion_583950): Future[string] {.
    ...stackTrace: false, raises: [Exception, ValueError],
    tags: [RootEffect, ReadDirEffect, ReadEnvEffect, ReadIOEffect, TimeEffect],
    forbids: [].}
HTTP METHOD GET
proc GetServerVersionV1(interfacename: AsyncIGCVersion_1046930): Future[string] {.
    ...stackTrace: false, raises: [Exception, ValueError],
    tags: [RootEffect, ReadDirEffect, ReadEnvEffect, ReadIOEffect, TimeEffect],
    forbids: [].}
HTTP METHOD GET
proc GetServerVersionV1(interfacename: AsyncIGCVersion_1269260): Future[string] {.
    ...stackTrace: false, raises: [Exception, ValueError],
    tags: [RootEffect, ReadDirEffect, ReadEnvEffect, ReadIOEffect, TimeEffect],
    forbids: [].}
HTTP METHOD GET
proc GetServerVersionV1(interfacename: IGCVersion_440): string {....raises: [
    LibraryError, SslError, Exception, IOError, OSError, ValueError,
    HttpRequestError, TimeoutError, ProtocolError, KeyError], tags: [RootEffect,
    ReadDirEffect, ReadEnvEffect, ReadIOEffect, WriteIOEffect, TimeEffect],
    forbids: [].}
HTTP METHOD GET
proc GetServerVersionV1(interfacename: IGCVersion_570): string {....raises: [
    LibraryError, SslError, Exception, IOError, OSError, ValueError,
    HttpRequestError, TimeoutError, ProtocolError, KeyError], tags: [RootEffect,
    ReadDirEffect, ReadEnvEffect, ReadIOEffect, WriteIOEffect, TimeEffect],
    forbids: [].}
HTTP METHOD GET
proc GetServerVersionV1(interfacename: IGCVersion_730): string {....raises: [
    LibraryError, SslError, Exception, IOError, OSError, ValueError,
    HttpRequestError, TimeoutError, ProtocolError, KeyError], tags: [RootEffect,
    ReadDirEffect, ReadEnvEffect, ReadIOEffect, WriteIOEffect, TimeEffect],
    forbids: [].}
HTTP METHOD GET
proc GetServerVersionV1(interfacename: IGCVersion_205790): string {....raises: [
    LibraryError, SslError, Exception, IOError, OSError, ValueError,
    HttpRequestError, TimeoutError, ProtocolError, KeyError], tags: [RootEffect,
    ReadDirEffect, ReadEnvEffect, ReadIOEffect, WriteIOEffect, TimeEffect],
    forbids: [].}
HTTP METHOD GET
proc GetServerVersionV1(interfacename: IGCVersion_583950): string {....raises: [
    LibraryError, SslError, Exception, IOError, OSError, ValueError,
    HttpRequestError, TimeoutError, ProtocolError, KeyError], tags: [RootEffect,
    ReadDirEffect, ReadEnvEffect, ReadIOEffect, WriteIOEffect, TimeEffect],
    forbids: [].}
HTTP METHOD GET
proc GetServerVersionV1(interfacename: IGCVersion_1046930): string {....raises: [
    LibraryError, SslError, Exception, IOError, OSError, ValueError,
    HttpRequestError, TimeoutError, ProtocolError, KeyError], tags: [RootEffect,
    ReadDirEffect, ReadEnvEffect, ReadIOEffect, WriteIOEffect, TimeEffect],
    forbids: [].}
HTTP METHOD GET
proc GetServerVersionV1(interfacename: IGCVersion_1269260): string {....raises: [
    LibraryError, SslError, Exception, IOError, OSError, ValueError,
    HttpRequestError, TimeoutError, ProtocolError, KeyError], tags: [RootEffect,
    ReadDirEffect, ReadEnvEffect, ReadIOEffect, WriteIOEffect, TimeEffect],
    forbids: [].}
HTTP METHOD GET
proc GetSteamPipeDomainsV1(interfacename: AsyncISteamDirectory): Future[string] {.
    ...stackTrace: false, raises: [Exception, ValueError],
    tags: [RootEffect, ReadDirEffect, ReadEnvEffect, ReadIOEffect, TimeEffect],
    forbids: [].}
HTTP METHOD GET
proc GetSteamPipeDomainsV1(interfacename: ISteamDirectory): string {....raises: [
    LibraryError, SslError, Exception, IOError, OSError, ValueError,
    HttpRequestError, TimeoutError, ProtocolError, KeyError], tags: [RootEffect,
    ReadDirEffect, ReadEnvEffect, ReadIOEffect, WriteIOEffect, TimeEffect],
    forbids: [].}
HTTP METHOD GET
proc GetSupportedAPIListV1(interfacename: AsyncISteamWebAPIUtil;
                           key = none(string)): Future[string] {.
    ...stackTrace: false, raises: [Exception, ValueError],
    tags: [RootEffect, ReadDirEffect, ReadEnvEffect, ReadIOEffect, TimeEffect],
    forbids: [].}
key : string — (Optional) access key
proc GetSupportedAPIListV1(interfacename: ISteamWebAPIUtil; key = none(string)): string {....raises: [
    LibraryError, SslError, Exception, IOError, OSError, ValueError,
    HttpRequestError, TimeoutError, ProtocolError, KeyError], tags: [RootEffect,
    ReadDirEffect, ReadEnvEffect, ReadIOEffect, WriteIOEffect, TimeEffect],
    forbids: [].}
key : string — (Optional) access key
proc GetTokenDetailsV1(interfacename: AsyncISteamUserOAuth;
                       access_token = none(string)): Future[string] {.
    ...stackTrace: false, raises: [Exception, ValueError],
    tags: [RootEffect, ReadDirEffect, ReadEnvEffect, ReadIOEffect, TimeEffect],
    forbids: [].}
access_token : string — (Required) OAuth2 token for which to return details
proc GetTokenDetailsV1(interfacename: ISteamUserOAuth;
                       access_token = none(string)): string {....raises: [
    LibraryError, SslError, Exception, IOError, OSError, ValueError,
    HttpRequestError, TimeoutError, ProtocolError, KeyError], tags: [RootEffect,
    ReadDirEffect, ReadEnvEffect, ReadIOEffect, WriteIOEffect, TimeEffect],
    forbids: [].}
access_token : string — (Required) OAuth2 token for which to return details
proc GetUserVoteSummaryV1(interfacename: AsyncIPublishedFileService;
                          publishedfileids = none(uint64)): Future[string] {.
    ...stackTrace: false, raises: [Exception, ValueError],
    tags: [RootEffect, ReadDirEffect, ReadEnvEffect, ReadIOEffect, TimeEffect],
    forbids: [].}
Get user vote summary publishedfileids : uint64 — (Required)
proc GetUserVoteSummaryV1(interfacename: IPublishedFileService;
                          publishedfileids = none(uint64)): string {....raises: [
    LibraryError, SslError, Exception, IOError, OSError, ValueError,
    HttpRequestError, TimeoutError, ProtocolError, KeyError], tags: [RootEffect,
    ReadDirEffect, ReadEnvEffect, ReadIOEffect, WriteIOEffect, TimeEffect],
    forbids: [].}
Get user vote summary publishedfileids : uint64 — (Required)
proc GetWorldStatusV1(interfacename: AsyncITFSystem_440): Future[string] {.
    ...stackTrace: false, raises: [Exception, ValueError],
    tags: [RootEffect, ReadDirEffect, ReadEnvEffect, ReadIOEffect, TimeEffect],
    forbids: [].}
HTTP METHOD GET
proc GetWorldStatusV1(interfacename: ITFSystem_440): string {....raises: [
    LibraryError, SslError, Exception, IOError, OSError, ValueError,
    HttpRequestError, TimeoutError, ProtocolError, KeyError], tags: [RootEffect,
    ReadDirEffect, ReadEnvEffect, ReadIOEffect, WriteIOEffect, TimeEffect],
    forbids: [].}
HTTP METHOD GET
proc newAsyncSteamWebAPI(): AsyncSteamWebAPI {....raises: [], tags: [], forbids: [].}
proc newSteamWebAPI(): SteamWebAPI {....raises: [], tags: [], forbids: [].}
proc PollStatusV1(interfacename: AsyncISteamWebUserPresenceOAuth;
                  steamid = none(string); umqid = none(uint64);
                  message = none(uint32); pollid = none(uint32);
                  sectimeout = none(uint32); secidletime = none(uint32);
                  use_accountids = none(uint32)): Future[string] {.
    ...stackTrace: false, raises: [Exception, ValueError],
    tags: [RootEffect, ReadDirEffect, ReadEnvEffect, ReadIOEffect, TimeEffect],
    forbids: [].}
steamid : string — (Required) Steam ID of the user umqid : uint64 — (Required) UMQ Session ID message : uint32 — (Required) Message that was last known to the user pollid : uint32 — (Optional) Caller-specific poll id sectimeout : uint32 — (Optional) Long-poll timeout in seconds secidletime : uint32 — (Optional) How many seconds is client considering itself idle, e.g. screen is off use_accountids : uint32 — (Optional) Boolean, 0 (default): return steamid_from in output, 1: return accountid_from
proc PollStatusV1(interfacename: ISteamWebUserPresenceOAuth;
                  steamid = none(string); umqid = none(uint64);
                  message = none(uint32); pollid = none(uint32);
                  sectimeout = none(uint32); secidletime = none(uint32);
                  use_accountids = none(uint32)): string {....raises: [
    LibraryError, SslError, Exception, IOError, OSError, KeyError, ValueError,
    HttpRequestError, TimeoutError, ProtocolError], tags: [RootEffect,
    ReadDirEffect, ReadEnvEffect, ReadIOEffect, WriteIOEffect, TimeEffect],
    forbids: [].}
steamid : string — (Required) Steam ID of the user umqid : uint64 — (Required) UMQ Session ID message : uint32 — (Required) Message that was last known to the user pollid : uint32 — (Optional) Caller-specific poll id sectimeout : uint32 — (Optional) Long-poll timeout in seconds secidletime : uint32 — (Optional) How many seconds is client considering itself idle, e.g. screen is off use_accountids : uint32 — (Optional) Boolean, 0 (default): return steamid_from in output, 1: return accountid_from
proc PostGameDataFrameRTMPV1(interfacename: AsyncIBroadcastService;
                             appid = none(uint32); steamid = none(uint64);
                             rtmp_token = none(string);
                             frame_data = none(string)): Future[string] {.
    ...stackTrace: false, raises: [Exception, ValueError],
    tags: [RootEffect, ReadDirEffect, ReadEnvEffect, ReadIOEffect, TimeEffect],
    forbids: [].}
Add a game meta data frame to broadcast from a client. Uses RTMP token for validation appid : uint32 — (Required) AppID of the game being broadcasted steamid : uint64 — (Required) Broadcasters SteamID rtmp_token : string — (Required) Valid RTMP token for the Broadcaster frame_data : string — (Required) game data frame expressing current state of game (string, zipped, whatever)
proc PostGameDataFrameRTMPV1(interfacename: IBroadcastService;
                             appid = none(uint32); steamid = none(uint64);
                             rtmp_token = none(string);
                             frame_data = none(string)): string {....raises: [
    LibraryError, SslError, Exception, IOError, OSError, KeyError, ValueError,
    HttpRequestError, TimeoutError, ProtocolError], tags: [RootEffect,
    ReadDirEffect, ReadEnvEffect, ReadIOEffect, WriteIOEffect, TimeEffect],
    forbids: [].}
Add a game meta data frame to broadcast from a client. Uses RTMP token for validation appid : uint32 — (Required) AppID of the game being broadcasted steamid : uint64 — (Required) Broadcasters SteamID rtmp_token : string — (Required) Valid RTMP token for the Broadcaster frame_data : string — (Required) game data frame expressing current state of game (string, zipped, whatever)
proc RecordOfflinePlaytimeV1(interfacename: AsyncIPlayerService;
                             steamid = none(uint64); ticket = none(string);
                             play_sessions = none(Message)): Future[string] {.
    ...stackTrace: false, raises: [Exception, ValueError],
    tags: [RootEffect, ReadDirEffect, ReadEnvEffect, ReadIOEffect, TimeEffect],
    forbids: [].}
Tracks playtime for a user when they are offline steamid : uint64 — (Required) ticket : string — (Required) play_sessions : Message — (Required)
proc RecordOfflinePlaytimeV1(interfacename: IPlayerService;
                             steamid = none(uint64); ticket = none(string);
                             play_sessions = none(Message)): string {....raises: [
    LibraryError, SslError, Exception, IOError, OSError, KeyError, ValueError,
    HttpRequestError, TimeoutError, ProtocolError], tags: [RootEffect,
    ReadDirEffect, ReadEnvEffect, ReadIOEffect, WriteIOEffect, TimeEffect],
    forbids: [].}
Tracks playtime for a user when they are offline steamid : uint64 — (Required) ticket : string — (Required) play_sessions : Message — (Required)
proc ReportEventV1(interfacename: AsyncIClientStats_1046930): Future[string] {.
    ...stackTrace: false, raises: [Exception, ValueError],
    tags: [RootEffect, ReadDirEffect, ReadEnvEffect, ReadIOEffect, TimeEffect],
    forbids: [].}
HTTP METHOD POST
proc ReportEventV1(interfacename: IClientStats_1046930): string {....raises: [
    LibraryError, SslError, Exception, IOError, OSError, KeyError, ValueError,
    HttpRequestError, TimeoutError, ProtocolError], tags: [RootEffect,
    ReadDirEffect, ReadEnvEffect, ReadIOEffect, WriteIOEffect, TimeEffect],
    forbids: [].}
HTTP METHOD POST
proc UploadUserApplicationLogV1(interfacename: AsyncIHelpRequestLogsService;
                                appid = none(uint32); log_type = none(string);
                                version_string = none(string);
                                log_contents = none(string);
                                request_id = none(uint64)): Future[string] {.
    ...stackTrace: false, raises: [Exception, ValueError],
    tags: [RootEffect, ReadDirEffect, ReadEnvEffect, ReadIOEffect, TimeEffect],
    forbids: [].}
User uploading application logs appid : uint32 — (Required) log_type : string — (Required) version_string : string — (Required) log_contents : string — (Required) request_id : uint64 — (Required)
proc UploadUserApplicationLogV1(interfacename: IHelpRequestLogsService;
                                appid = none(uint32); log_type = none(string);
                                version_string = none(string);
                                log_contents = none(string);
                                request_id = none(uint64)): string {....raises: [
    LibraryError, SslError, Exception, IOError, OSError, KeyError, ValueError,
    HttpRequestError, TimeoutError, ProtocolError], tags: [RootEffect,
    ReadDirEffect, ReadEnvEffect, ReadIOEffect, WriteIOEffect, TimeEffect],
    forbids: [].}
User uploading application logs appid : uint32 — (Required) log_type : string — (Required) version_string : string — (Required) log_contents : string — (Required) request_id : uint64 — (Required)
proc UpToDateCheckV1(interfacename: AsyncISteamApps; appid = none(uint32);
                     version = none(uint32)): Future[string] {.
    ...stackTrace: false, raises: [Exception, ValueError],
    tags: [RootEffect, ReadDirEffect, ReadEnvEffect, ReadIOEffect, TimeEffect],
    forbids: [].}
appid : uint32 — (Required) AppID of game version : uint32 — (Required) The installed version of the game
proc UpToDateCheckV1(interfacename: ISteamApps; appid = none(uint32);
                     version = none(uint32)): string {....raises: [LibraryError,
    SslError, Exception, IOError, OSError, ValueError, HttpRequestError,
    TimeoutError, ProtocolError, KeyError], tags: [RootEffect, ReadDirEffect,
    ReadEnvEffect, ReadIOEffect, WriteIOEffect, TimeEffect], forbids: [].}
appid : uint32 — (Required) AppID of game version : uint32 — (Required) The installed version of the game
proc UserCreateSessionV1(interfacename: AsyncIGameNotificationsService;
                         appid = none(uint32); context = none(uint64);
                         title = none(Message); users = none(Message);
                         steamid = none(uint64)): Future[string] {.
    ...stackTrace: false, raises: [Exception, ValueError],
    tags: [RootEffect, ReadDirEffect, ReadEnvEffect, ReadIOEffect, TimeEffect],
    forbids: [].}
Creates an async game session appid : uint32 — (Required) The appid to create the session for. context : uint64 — (Required) Game-specified context value the game can used to associate the session with some object on their backend. title : Message — (Required) The title of the session to be displayed within each user's list of sessions. users : Message — (Required) The initial state of all users in the session. steamid : uint64 — (Required) (Optional) steamid to make the request on behalf of -- if specified, the user must be in the session and all users being added to the session must be friends with the user.
proc UserCreateSessionV1(interfacename: IGameNotificationsService;
                         appid = none(uint32); context = none(uint64);
                         title = none(Message); users = none(Message);
                         steamid = none(uint64)): string {....raises: [
    LibraryError, SslError, Exception, IOError, OSError, KeyError, ValueError,
    HttpRequestError, TimeoutError, ProtocolError], tags: [RootEffect,
    ReadDirEffect, ReadEnvEffect, ReadIOEffect, WriteIOEffect, TimeEffect],
    forbids: [].}
Creates an async game session appid : uint32 — (Required) The appid to create the session for. context : uint64 — (Required) Game-specified context value the game can used to associate the session with some object on their backend. title : Message — (Required) The title of the session to be displayed within each user's list of sessions. users : Message — (Required) The initial state of all users in the session. steamid : uint64 — (Required) (Optional) steamid to make the request on behalf of -- if specified, the user must be in the session and all users being added to the session must be friends with the user.
proc UserDeleteSessionV1(interfacename: AsyncIGameNotificationsService;
                         sessionid = none(uint64); appid = none(uint32);
                         steamid = none(uint64)): Future[string] {.
    ...stackTrace: false, raises: [Exception, ValueError],
    tags: [RootEffect, ReadDirEffect, ReadEnvEffect, ReadIOEffect, TimeEffect],
    forbids: [].}
Deletes an async game session sessionid : uint64 — (Required) The sessionid to delete. appid : uint32 — (Required) The appid of the session to delete. steamid : uint64 — (Required) (Optional) steamid to make the request on behalf of -- if specified, the user must be in the session.
proc UserDeleteSessionV1(interfacename: IGameNotificationsService;
                         sessionid = none(uint64); appid = none(uint32);
                         steamid = none(uint64)): string {....raises: [
    LibraryError, SslError, Exception, IOError, OSError, KeyError, ValueError,
    HttpRequestError, TimeoutError, ProtocolError], tags: [RootEffect,
    ReadDirEffect, ReadEnvEffect, ReadIOEffect, WriteIOEffect, TimeEffect],
    forbids: [].}
Deletes an async game session sessionid : uint64 — (Required) The sessionid to delete. appid : uint32 — (Required) The appid of the session to delete. steamid : uint64 — (Required) (Optional) steamid to make the request on behalf of -- if specified, the user must be in the session.
proc UserUpdateSessionV1(interfacename: AsyncIGameNotificationsService;
                         sessionid = none(uint64); appid = none(uint32);
                         title = none(Message); users = none(Message);
                         steamid = none(uint64)): Future[string] {.
    ...stackTrace: false, raises: [Exception, ValueError],
    tags: [RootEffect, ReadDirEffect, ReadEnvEffect, ReadIOEffect, TimeEffect],
    forbids: [].}
Updates an async game session sessionid : uint64 — (Required) The sessionid to update. appid : uint32 — (Required) The appid of the session to update. title : Message — (Required) (Optional) The new title of the session. If not specified, the title will not be changed. users : Message — (Required) (Optional) A list of users whose state will be updated to reflect the given state. If the users are not already in the session, they will be added to it. steamid : uint64 — (Required) (Optional) steamid to make the request on behalf of -- if specified, the user must be in the session and all users being added to the session must be friends with the user.
proc UserUpdateSessionV1(interfacename: IGameNotificationsService;
                         sessionid = none(uint64); appid = none(uint32);
                         title = none(Message); users = none(Message);
                         steamid = none(uint64)): string {....raises: [
    LibraryError, SslError, Exception, IOError, OSError, KeyError, ValueError,
    HttpRequestError, TimeoutError, ProtocolError], tags: [RootEffect,
    ReadDirEffect, ReadEnvEffect, ReadIOEffect, WriteIOEffect, TimeEffect],
    forbids: [].}
Updates an async game session sessionid : uint64 — (Required) The sessionid to update. appid : uint32 — (Required) The appid of the session to update. title : Message — (Required) (Optional) The new title of the session. If not specified, the title will not be changed. users : Message — (Required) (Optional) A list of users whose state will be updated to reflect the given state. If the users are not already in the session, they will be added to it. steamid : uint64 — (Required) (Optional) steamid to make the request on behalf of -- if specified, the user must be in the session and all users being added to the session must be friends with the user.
proc ViewerHeartbeatV1(interfacename: AsyncISteamBroadcast;
                       steamid = none(uint64); sessionid = none(uint64);
                       token = none(uint64); stream = none(int32)): Future[
    string] {....stackTrace: false, raises: [Exception, ValueError], tags: [
    RootEffect, ReadDirEffect, ReadEnvEffect, ReadIOEffect, TimeEffect],
              forbids: [].}
steamid : uint64 — (Required) Steam ID of the broadcaster sessionid : uint64 — (Required) Broadcast Session ID token : uint64 — (Required) Viewer token stream : int32 — (Optional) video stream representation watching
proc ViewerHeartbeatV1(interfacename: ISteamBroadcast; steamid = none(uint64);
                       sessionid = none(uint64); token = none(uint64);
                       stream = none(int32)): string {....raises: [LibraryError,
    SslError, Exception, IOError, OSError, ValueError, HttpRequestError,
    TimeoutError, ProtocolError, KeyError], tags: [RootEffect, ReadDirEffect,
    ReadEnvEffect, ReadIOEffect, WriteIOEffect, TimeEffect], forbids: [].}
steamid : uint64 — (Required) Steam ID of the broadcaster sessionid : uint64 — (Required) Broadcast Session ID token : uint64 — (Required) Viewer token stream : int32 — (Optional) video stream representation watching

Converters

converter toOption[T](x: T): Option[T]