files

Documentation

Index

• type AddResult
  • func Add(client *cliHttp.SimpleClient, gameID, packageID int, ...) (*AddResult, error)
• type GetResult
  • func Get(client *cliHttp.SimpleClient, gameID int, size int64, checksum string) (*GetResult, error)
• type RestartResult
  • func Restart(client *cliHttp.SimpleClient, gameID int, size int64, checksum string) (*RestartResult, error)

Types

type AddResult

type AddResult struct {
	GetResult
	Build *models.GameBuild `json:"build,omitempty"` // Only returned once when the file has been fully uploaded
}

AddResult is the result from the /files/add endpoint

func Add

func Add(client *cliHttp.SimpleClient, gameID, packageID int, releaseVersion *semver.Version, isDownloadable bool, size int64, checksum string, forceRestart bool, filepath string, startByte, chunkSize int64, bar *pb.ProgressBar) (*AddResult, error)

Add sends a new POST /files/add request

type GetResult

type GetResult struct {
	Status string        `json:"status"`
	FileID int           `json:"file_id,omitempty"` // Returned for partial/in progress file uploads
	Start  int64         `json:"start,omitempty"`
	Error  *models.Error `json:"error,omitempty"`
}

GetResult is the result from the /files endpoint

func Get

func Get(client *cliHttp.SimpleClient, gameID int, size int64, checksum string) (*GetResult, error)

Get sends a new GET /files/add request

type RestartResult

type RestartResult struct {
	FileID int           `json:"file_id,omitempty"` // The existing file upload that was restarted
	Error  *models.Error `json:"error,omitempty"`
}

func Restart

func Restart(client *cliHttp.SimpleClient, gameID int, size int64, checksum string) (*RestartResult, error)

Restart sends a new POST /files/add request that restarts an existing upload.