Documentation
¶
Index ¶
- Constants
- func FromDateTime(s string) (time.Time, error)
- func ToDateTime(t time.Time) string
- type AllowSandboxSetupParams
- type AllowSandboxSetupResponse
- type CheckUpdateItem
- type CheckUpdateParams
- type CheckUpdateResult
- type CleanDownloadsApplyParams
- type CleanDownloadsApplyResult
- type CleanDownloadsEntry
- type CleanDownloadsSearchParams
- type CleanDownloadsSearchResult
- type GameCredentials
- type GameFindUploadsParams
- type GameFindUploadsResult
- type GameUpdate
- type GameUpdateAvailableNotification
- type GetReceiptParams
- type GetReceiptResult
- type HTMLLaunchParams
- type HTMLLaunchResult
- type InstallParams
- type InstallResult
- type LFObjectCodec
- type LaunchExitedNotification
- type LaunchParams
- type LaunchResult
- type LaunchRunningNotification
- type LogNotification
- type Operation
- type OperationCancelParams
- type OperationCancelResult
- type OperationProgressNotification
- type OperationResult
- type OperationStartParams
- type PickManifestActionParams
- type PickManifestActionResult
- type PickUploadParams
- type PickUploadResult
- type PrereqStatus
- type PrereqTask
- type PrereqsEndedNotification
- type PrereqsFailedParams
- type PrereqsFailedResult
- type PrereqsStartedNotification
- type PrereqsTaskStateNotification
- type SaveVerdictParams
- type SaveVerdictResult
- type Server
- type ShellLaunchParams
- type ShellLaunchResult
- type TaskReason
- type TaskStartedNotification
- type TaskSucceededNotification
- type TaskType
- type TestDoubleRequest
- type TestDoubleResult
- type TestDoubleTwiceRequest
- type TestDoubleTwiceResult
- type URLLaunchParams
- type URLLaunchResult
- type UninstallParams
- type VersionGetParams
- type VersionGetResult
Constants ¶
View Source
const ( CodeOperationCancelled = 499 CodeOperationAborted = 410 )
Variables ¶
This section is empty.
Functions ¶
func ToDateTime ¶
Types ¶
type AllowSandboxSetupParams ¶
type AllowSandboxSetupParams struct{}
type AllowSandboxSetupResponse ¶
type AllowSandboxSetupResponse struct {
Allow bool `json:"allow"`
}
type CheckUpdateItem ¶
type CheckUpdateParams ¶
type CheckUpdateParams struct {
Items []*CheckUpdateItem `json:"items"`
}
type CheckUpdateResult ¶
type CheckUpdateResult struct {
Updates []*GameUpdate `json:"updates"`
Warnings []string `json:"warnings"`
}
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 GameUpdate ¶
type GameUpdateAvailableNotification ¶
type GameUpdateAvailableNotification struct {
Update *GameUpdate `json:"update"`
}
type GetReceiptParams ¶
type GetReceiptParams struct {
}
type GetReceiptResult ¶
type HTMLLaunchParams ¶
type HTMLLaunchResult ¶
type HTMLLaunchResult struct {
}
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"`
IgnoreInstallers bool `json:"ignoreInstallers,omitempty"`
}
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 LaunchExitedNotification ¶
type LaunchExitedNotification struct{}
type LaunchParams ¶
type LaunchParams struct {
InstallFolder string `json:"installFolder"`
Game *itchio.Game `json:"game"`
Upload *itchio.Upload `json:"upload"`
Build *itchio.Build `json:"build"`
Verdict *configurator.Verdict `json:"verdict"`
PrereqsDir string `json:"prereqsDir"`
ForcePrereqs bool `json:"forcePrereqs,omitempty"`
Sandbox bool `json:"sandbox,omitempty"`
// Used for subkeying
Credentials *GameCredentials `json:"credentials"`
}
type LaunchResult ¶
type LaunchResult struct {
}
type LaunchRunningNotification ¶
type LaunchRunningNotification struct{}
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 PickManifestActionResult ¶
type PickManifestActionResult struct {
Name string `json:"name"`
}
type PickUploadParams ¶
type PickUploadResult ¶
type PickUploadResult struct {
Index int64 `json:"index"`
}
type PrereqStatus ¶
type PrereqStatus string
const ( PrereqStatusPending PrereqStatus = "pending" PrereqStatusDownloading PrereqStatus = "downloading" PrereqStatusReady PrereqStatus = "ready" PrereqStatusInstalling PrereqStatus = "installing" PrereqStatusDone PrereqStatus = "done" )
type PrereqTask ¶
type PrereqsEndedNotification ¶
type PrereqsEndedNotification struct {
}
type PrereqsFailedParams ¶
type PrereqsFailedResult ¶
type PrereqsFailedResult struct {
Continue bool `json:"continue"`
}
type PrereqsStartedNotification ¶
type PrereqsStartedNotification struct {
Tasks map[string]*PrereqTask `json:"tasks"`
}
type PrereqsTaskStateNotification ¶
type PrereqsTaskStateNotification struct {
Name string `json:"name"`
Status PrereqStatus `json:"status"`
Progress float64 `json:"progress"`
ETA float64 `json:"eta"`
BPS float64 `json:"bps"`
}
type SaveVerdictParams ¶
type SaveVerdictParams struct {
Verdict *configurator.Verdict `json:"verdict"`
}
type SaveVerdictResult ¶
type SaveVerdictResult struct{}
type ShellLaunchParams ¶
type ShellLaunchParams struct {
ItemPath string `json:"itemPath"`
}
type ShellLaunchResult ¶
type ShellLaunchResult struct {
}
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 URLLaunchParams ¶
type URLLaunchParams struct {
URL string `json:"url"`
}
type URLLaunchResult ¶
type URLLaunchResult struct{}
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.