Home Reference Source
public class | source

Docker

Constructor Summary

Public Constructor
public

Member Summary

Public Members
public

API: *

Private Members
private

_token: *

Method Summary

Public Methods
public

create(user_id: String, game: String, server_name: String): *

Create a server

public

delete(user_id: String, container_id: String): *

Delete a server

public

infos(user_id: String, container_id: String): *

Get the info of a server

public

list(user_id: String): *

List the server of a specific user

public

logs(user_id: String, container_id: String): *

Get the logs of a server

public

playersOnline(user_id: String, container_id: String): *

Get the players online on a specific server

public

start(user_id: String, container_id: String): *

Start a specific server

public

stop(user_id: String, container_id: String): *

Stop a server

public

update(user_id: String, container_id: String, server_name: String): *

Update a server

Public Constructors

public constructor(token: String) source

Params:

NameTypeAttributeDescription
token String

Public Members

public API: * source

Private Members

private _token: * source

Public Methods

public create(user_id: String, game: String, server_name: String): * source

Create a server

Params:

NameTypeAttributeDescription
user_id String

The id of the user

game String

The game to create the server

server_name String

The name of your server

Return:

*

public delete(user_id: String, container_id: String): * source

Delete a server

Params:

NameTypeAttributeDescription
user_id String

The id of the user

container_id String

The id of the container

Return:

*

public infos(user_id: String, container_id: String): * source

Get the info of a server

Params:

NameTypeAttributeDescription
user_id String

The id of the user

container_id String

The id of the container

Return:

*

public list(user_id: String): * source

List the server of a specific user

Params:

NameTypeAttributeDescription
user_id String

Return:

*

public logs(user_id: String, container_id: String): * source

Get the logs of a server

Params:

NameTypeAttributeDescription
user_id String

The id of the user

container_id String

The id of the container

Return:

*

public playersOnline(user_id: String, container_id: String): * source

Get the players online on a specific server

Params:

NameTypeAttributeDescription
user_id String

The id of the user

container_id String

The id of the container

Return:

*

public start(user_id: String, container_id: String): * source

Start a specific server

Params:

NameTypeAttributeDescription
user_id String

The id of the user

container_id String

The id of the container

Return:

*

public stop(user_id: String, container_id: String): * source

Stop a server

Params:

NameTypeAttributeDescription
user_id String

The id of the user

container_id String

The id of the container

Return:

*

public update(user_id: String, container_id: String, server_name: String): * source

Update a server

Params:

NameTypeAttributeDescription
user_id String

The id of the user

container_id String

The id of the container to update

server_name String

The new name of the server

Return:

*