Documentation ¶
Index ¶
- Constants
- type CleanDownloadsApplyParams
- type CleanDownloadsApplyResult
- type CleanDownloadsEntry
- type CleanDownloadsSearchParams
- type CleanDownloadsSearchResult
- type GameCredentials
- type GameFindUploadsParams
- type GameFindUploadsResult
- type GetReceiptParams
- type GetReceiptResult
- type InstallParams
- type InstallResult
- type LFObjectCodec
- type LogNotification
- type Operation
- type OperationCancelParams
- type OperationCancelResult
- type OperationProgressNotification
- type OperationResult
- type OperationStartParams
- type PickUploadParams
- type PickUploadResult
- type Server
- type TaskReason
- type TaskStartedNotification
- type TaskSucceededNotification
- type TaskType
- type TestDoubleRequest
- type TestDoubleResult
- type TestDoubleTwiceRequest
- type TestDoubleTwiceResult
- type UninstallParams
- type VersionGetParams
- type VersionGetResult
Constants ¶
View Source
const ( CodeOperationCancelled = 499 CodeOperationAborted = 410 )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type CleanDownloadsApplyParams ¶
type CleanDownloadsApplyParams struct {
Entries []*CleanDownloadsEntry `json:"entries"`
}
type CleanDownloadsApplyResult ¶
type CleanDownloadsApplyResult struct{}
type CleanDownloadsEntry ¶
type CleanDownloadsSearchParams ¶
type CleanDownloadsSearchParams struct { // A list of folders to scan for potential subfolders to clean up Roots []string `json:"roots"` // A list of subfolders to not consider when cleaning // (staging folders for in-progress downloads) Whitelist []string `json:"whitelist"` }
CleanDownloads.Search
type CleanDownloadsSearchResult ¶
type CleanDownloadsSearchResult struct {
Entries []*CleanDownloadsEntry `json:"entries"`
}
type GameCredentials ¶
type GameCredentials struct { Server string `json:"server"` APIKey string `json:"apiKey"` DownloadKey int64 `json:"downloadKey"` }
GameCredentials contains all the credentials required to make API requests including the download key if any
type GameFindUploadsParams ¶
type GameFindUploadsParams struct { Game *itchio.Game `json:"game"` Credentials *GameCredentials `json:"credentials"` }
Game.FindUploads
type GameFindUploadsResult ¶
type GetReceiptParams ¶
type GetReceiptParams struct { }
type GetReceiptResult ¶
type InstallParams ¶
type InstallParams struct { Game *itchio.Game `json:"game"` InstallFolder string `json:"installFolder"` Upload *itchio.Upload `json:"upload"` Build *itchio.Build `json:"build"` Credentials *GameCredentials `json:"credentials"` }
InstallParams contains all the parameters needed to perform an installation for a game
type InstallResult ¶
type LFObjectCodec ¶
type LFObjectCodec struct{}
func (LFObjectCodec) ReadObject ¶
func (LFObjectCodec) ReadObject(stream *bufio.Reader, v interface{}) error
func (LFObjectCodec) WriteObject ¶
func (LFObjectCodec) WriteObject(stream io.Writer, obj interface{}) error
type LogNotification ¶
Log
type OperationCancelParams ¶
type OperationCancelParams struct {
ID string `json:"id"`
}
Operation.Cancel
type OperationCancelResult ¶
type OperationCancelResult struct{}
type OperationProgressNotification ¶
type OperationProgressNotification struct { Progress float64 `json:"progress"` ETA float64 `json:"eta"` BPS float64 `json:"bps"` }
Operation.Progress Sent periodically to inform on the current state an operation
type OperationStartParams ¶
type OperationStartParams struct { ID string `json:"id"` StagingFolder string `json:"stagingFolder"` Operation Operation `json:"operation"` // this is more or less a union, the relevant field // should be set depending on the 'Operation' type InstallParams *InstallParams `json:"installParams,omitempty"` UninstallParams *UninstallParams `json:"uninstallParams,omitempty"` }
Operation.Start
type PickUploadParams ¶
type PickUploadResult ¶
type PickUploadResult struct {
Index int64 `json:"index"`
}
type TaskReason ¶
type TaskReason string
const ( TaskReasonInstall TaskReason = "install" TaskReasonUninstall TaskReason = "uninstall" )
type TaskStartedNotification ¶
type TaskSucceededNotification ¶
type TaskSucceededNotification struct { Type TaskType `json:"type"` // If the task installed something, then this contains // info about the game, upload, build that were installed InstallResult *InstallResult `json:"installResult,omitempty"` }
type TestDoubleResult ¶
type TestDoubleResult struct {
Number int64 `json:"number"`
}
Result for Test.Double
type TestDoubleTwiceRequest ¶
type TestDoubleTwiceRequest struct {
Number int64 `json:"number"`
}
Test.DoubleTwice
type TestDoubleTwiceResult ¶
type TestDoubleTwiceResult struct {
Number int64 `json:"number"`
}
Result for Test.DoubleTwice
type UninstallParams ¶
type UninstallParams struct {
InstallFolder string `json:"installFolder"`
}
type VersionGetResult ¶
type VersionGetResult struct { // Something short, like `v8.0.0` Version string `json:"version"` // Something long, like `v8.0.0, built on Aug 27 2017 @ 01:13:55, ref d833cc0aeea81c236c81dffb27bc18b2b8d8b290` VersionString string `json:"versionString"` }
Result for Version.Get
Click to show internal directories.
Click to hide internal directories.