go_playflow

README

go-playflow

A Go implementation of the Playflow API

Documentation

Index

• Constants
• Variables
• type Client
  • func NewClient(token string, url ...string) (*Client, error)
  • func (c *Client) DeleteServerTag(serverTag string) (interface{}, error)
  • func (c *Client) PerformanceMetrics() ([]string, error)
  • func (c *Client) RestartGameServer(serverArguments, serverType, serverTag *string) (interface{}, error)
  • func (c *Client) ServerLogs() ([]string, error)
  • func (c *Client) ServerStatus(matchId string) (interface{}, error)
  • func (c *Client) ServerTags() (interface{}, error)
  • func (c *Client) Servers(includeLaunching ...bool) (interface{}, error)
  • func (c *Client) StartGameServer(serverArguments, serverRegion, serverType, serverTag *string) (interface{}, error)
  • func (c *Client) StopGameServer(matchId string) (interface{}, error)
  • func (c *Client) UploadServerFiles(fileToUpload *[]byte, serverTag ...string) error
  • func (c *Client) UploadVersion() (string, error)
• type HTTPValidationError
• type ServerList
• type ServerTags

Constants

const PlayFlowProductionAPI = "https://api.cloud.playflow.app"

Variables

var (
	ErrInvalidMethod = errors.New("invalid method")
)

Types

type Client

type Client struct {
	HTTP *http.Client
	// contains filtered or unexported fields
}

func NewClient

func NewClient(token string, url ...string) (*Client, error)

func (*Client) DeleteServerTag

func (c *Client) DeleteServerTag(serverTag string) (interface{}, error)

func (*Client) PerformanceMetrics

func (c *Client) PerformanceMetrics() ([]string, error)

func (*Client) RestartGameServer

func (c *Client) RestartGameServer(serverArguments, serverType, serverTag *string) (interface{}, error)

func (*Client) ServerLogs

func (c *Client) ServerLogs() ([]string, error)

func (*Client) ServerStatus

func (c *Client) ServerStatus(matchId string) (interface{}, error)

func (*Client) ServerTags

func (c *Client) ServerTags() (interface{}, error)

func (*Client) Servers

func (c *Client) Servers(includeLaunching ...bool) (interface{}, error)

func (*Client) StartGameServer

func (c *Client) StartGameServer(serverArguments, serverRegion, serverType, serverTag *string) (interface{}, error)

func (*Client) StopGameServer

func (c *Client) StopGameServer(matchId string) (interface{}, error)

func (*Client) UploadServerFiles

func (c *Client) UploadServerFiles(fileToUpload *[]byte, serverTag ...string) error

func (*Client) UploadVersion

func (c *Client) UploadVersion() (string, error)

type HTTPValidationError

type HTTPValidationError struct {
	ValidationError []struct {
		Loc  []any  `json:"loc"`
		Msg  string `json:"msg"`
		Type string `json:"type"`
	} `json:"detail"`
}

type ServerList

type ServerList struct {
	TotalServers int `json:"total_servers"`
	Servers      []struct {
	}
}

type ServerTags

type ServerTags struct {
}