client

package
v0.0.21 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 20, 2023 License: Apache-2.0 Imports: 13 Imported by: 0

Documentation

Index

Constants

View Source
const (
	V1ItemRoute string = "/v1/item"
)
View Source
const (
	V1PlayerRoute string = "/v1/player"
)
View Source
const (
	V1RoomRoute string = "/v1/room"
)

Variables

This section is empty.

Functions

func TranslateItem

func TranslateItem(i rest.Item) (*asset.Item, error)

TranslateItem translates a network item into an asset item.

func TranslateItemChange

func TranslateItemChange(i asset.ItemChange) (rest.ItemRequest, error)

TranslateItemChange translates an asset item change struct to a network item request.

func TranslatePlayer

func TranslatePlayer(p rest.Player) (*asset.Player, error)

TranslatePlayer translates a network player into an asset player.

func TranslatePlayerChange

func TranslatePlayerChange(i asset.PlayerChange) (rest.PlayerRequest, error)

TranslatePlayerChange translates an asset player change struct to a network player request.

func TranslateRoom added in v0.0.21

func TranslateRoom(p rest.Room) (*asset.Room, error)

TranslateRoom translates a network room into an asset room.

func TranslateRoomChange added in v0.0.21

func TranslateRoomChange(i asset.RoomChange) (rest.RoomRequest, error)

TranslateRoomChange translates an asset room change struct to a network room request.

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client provides a client for the asset api.

func New

func New(baseURL string, opts ...ClientOption) *Client

New returns a new client for the asset API.

func (Client) CreateItem

func (c Client) CreateItem(ctx context.Context, item asset.ItemCreate) (*asset.Item, error)

CreateItem creates an item.

func (Client) CreatePlayer

func (c Client) CreatePlayer(ctx context.Context, player asset.PlayerCreate) (*asset.Player, error)

CreatePlayer creates an player.

func (Client) CreateRoom added in v0.0.21

func (c Client) CreateRoom(ctx context.Context, room asset.RoomCreate) (*asset.Room, error)

CreateRoom creates an room.

func (Client) GetItem

func (c Client) GetItem(ctx context.Context, id asset.ItemID) (*asset.Item, error)

GetItem returns an item for the given item id.

func (Client) GetPlayer

func (c Client) GetPlayer(ctx context.Context, id asset.PlayerID) (*asset.Player, error)

GetPlayer returns an player for the given player id.

func (Client) GetRoom added in v0.0.21

func (c Client) GetRoom(ctx context.Context, id asset.RoomID) (*asset.Room, error)

GetRoom returns an room for the given room id.

func (Client) ListItems

func (c Client) ListItems(ctx context.Context, filter asset.ItemFilter) ([]*asset.Item, error)

ListItems returns a list of items for the given item filter.

func (Client) ListPlayers

func (c Client) ListPlayers(ctx context.Context, filter asset.PlayerFilter) ([]*asset.Player, error)

ListPlayers returns a list of players for the given player filter.

func (Client) ListRooms added in v0.0.21

func (c Client) ListRooms(ctx context.Context, filter asset.RoomFilter) ([]*asset.Room, error)

ListRooms returns a list of rooms for the given room filter.

func (Client) RemoveItem

func (c Client) RemoveItem(ctx context.Context, id asset.ItemID) error

RemoveItem deletes an item.

func (Client) RemovePlayer

func (c Client) RemovePlayer(ctx context.Context, id asset.PlayerID) error

RemovePlayer deletes an player.

func (Client) RemoveRoom added in v0.0.21

func (c Client) RemoveRoom(ctx context.Context, id asset.RoomID) error

RemoveRoom deletes an room.

func (Client) UpdateItem

func (c Client) UpdateItem(ctx context.Context, id asset.ItemID, item asset.ItemUpdate) (*asset.Item, error)

UpdateItem updates the item with the given item update.

func (Client) UpdatePlayer

func (c Client) UpdatePlayer(ctx context.Context, id asset.PlayerID, player asset.PlayerUpdate) (*asset.Player, error)

UpdatePlayer updates the player with the given player update.

func (Client) UpdateRoom added in v0.0.21

func (c Client) UpdateRoom(ctx context.Context, id asset.RoomID, room asset.RoomUpdate) (*asset.Room, error)

UpdateRoom updates the room with the given room update.

type ClientOption

type ClientOption interface {
	// contains filtered or unexported methods
}

ClientOption provides options for configuring the creation of an asset client.

func WithTimeout

func WithTimeout(timeout time.Duration) ClientOption

WithTime sets the client timeout.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL