GameSparks

import { GameSparks } from "https://aws-api.deno.dev/v0.4/services/gamesparks.ts?docs=full";

class GameSparks {

constructor(apiFactory: client.ApiFactory);

async createGame(params: CreateGameRequest, opts?: client.RequestOptions): Promise<CreateGameResult>;

async createSnapshot(params: CreateSnapshotRequest, opts?: client.RequestOptions): Promise<CreateSnapshotResult>;

async createStage(params: CreateStageRequest, opts?: client.RequestOptions): Promise<CreateStageResult>;

async deleteGame(params: DeleteGameRequest, opts?: client.RequestOptions): Promise<void>;

async deleteStage(params: DeleteStageRequest, opts?: client.RequestOptions): Promise<void>;

async disconnectPlayer(params: DisconnectPlayerRequest, opts?: client.RequestOptions): Promise<DisconnectPlayerResult>;

async exportSnapshot(params: ExportSnapshotRequest, opts?: client.RequestOptions): Promise<ExportSnapshotResult>;

async getExtension(params: GetExtensionRequest, opts?: client.RequestOptions): Promise<GetExtensionResult>;

async getExtensionVersion(params: GetExtensionVersionRequest, opts?: client.RequestOptions): Promise<GetExtensionVersionResult>;

async getGame(params: GetGameRequest, opts?: client.RequestOptions): Promise<GetGameResult>;

async getGameConfiguration(params: GetGameConfigurationRequest, opts?: client.RequestOptions): Promise<GetGameConfigurationResult>;

async getGeneratedCodeJob(params: GetGeneratedCodeJobRequest, opts?: client.RequestOptions): Promise<GetGeneratedCodeJobResult>;

async getPlayerConnectionStatus(params: GetPlayerConnectionStatusRequest, opts?: client.RequestOptions): Promise<GetPlayerConnectionStatusResult>;

async getSnapshot(params: GetSnapshotRequest, opts?: client.RequestOptions): Promise<GetSnapshotResult>;

async getStage(params: GetStageRequest, opts?: client.RequestOptions): Promise<GetStageResult>;

async getStageDeployment(params: GetStageDeploymentRequest, opts?: client.RequestOptions): Promise<GetStageDeploymentResult>;

async importGameConfiguration(params: ImportGameConfigurationRequest, opts?: client.RequestOptions): Promise<ImportGameConfigurationResult>;

async listExtensions(params?: ListExtensionsRequest, opts?: client.RequestOptions): Promise<ListExtensionsResult>;

async listExtensionVersions(params: ListExtensionVersionsRequest, opts?: client.RequestOptions): Promise<ListExtensionVersionsResult>;

async listGames(params?: ListGamesRequest, opts?: client.RequestOptions): Promise<ListGamesResult>;

async listGeneratedCodeJobs(params: ListGeneratedCodeJobsRequest, opts?: client.RequestOptions): Promise<ListGeneratedCodeJobsResult>;

async listSnapshots(params: ListSnapshotsRequest, opts?: client.RequestOptions): Promise<ListSnapshotsResult>;

async listStageDeployments(params: ListStageDeploymentsRequest, opts?: client.RequestOptions): Promise<ListStageDeploymentsResult>;

async listStages(params: ListStagesRequest, opts?: client.RequestOptions): Promise<ListStagesResult>;

async listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResult>;

async startGeneratedCodeJob(params: StartGeneratedCodeJobRequest, opts?: client.RequestOptions): Promise<StartGeneratedCodeJobResult>;

async startStageDeployment(params: StartStageDeploymentRequest, opts?: client.RequestOptions): Promise<StartStageDeploymentResult>;

async tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>;

async untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>;

async updateGame(params: UpdateGameRequest, opts?: client.RequestOptions): Promise<UpdateGameResult>;

async updateGameConfiguration(params: UpdateGameConfigurationRequest, opts?: client.RequestOptions): Promise<UpdateGameConfigurationResult>;

async updateSnapshot(params: UpdateSnapshotRequest, opts?: client.RequestOptions): Promise<UpdateSnapshotResult>;

async updateStage(params: UpdateStageRequest, opts?: client.RequestOptions): Promise<UpdateStageResult>;

static ApiMetadata: client.ApiMetadata;

}

§Constructors

new GameSparks(apiFactory: client.ApiFactory)

[src]

§Methods

createGame(params: CreateGameRequest, opts?: client.RequestOptions): Promise<CreateGameResult>

[src]

Creates a new game with an empty configuration. After creating your game, you can update the configuration using UpdateGameConfiguration or ImportGameConfiguration.

createSnapshot(params: CreateSnapshotRequest, opts?: client.RequestOptions): Promise<CreateSnapshotResult>

[src]

Creates a snapshot of the game configuration.

createStage(params: CreateStageRequest, opts?: client.RequestOptions): Promise<CreateStageResult>

[src]

Creates a new stage for stage-by-stage game development and deployment.

deleteGame(params: DeleteGameRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deletes a game.

deleteStage(params: DeleteStageRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deletes a stage from a game, along with the associated game runtime.

disconnectPlayer(params: DisconnectPlayerRequest, opts?: client.RequestOptions): Promise<DisconnectPlayerResult>

[src]

Disconnects a player from the game runtime.

If a player has multiple connections, this operation attempts to close all of them.

exportSnapshot(params: ExportSnapshotRequest, opts?: client.RequestOptions): Promise<ExportSnapshotResult>

[src]

Exports a game configuration snapshot.

getExtension(params: GetExtensionRequest, opts?: client.RequestOptions): Promise<GetExtensionResult>

[src]

Gets details about a specified extension.

getExtensionVersion(params: GetExtensionVersionRequest, opts?: client.RequestOptions): Promise<GetExtensionVersionResult>

[src]

Gets details about a specified extension version.

getGame(params: GetGameRequest, opts?: client.RequestOptions): Promise<GetGameResult>

[src]

Gets details about a game.

getGameConfiguration(params: GetGameConfigurationRequest, opts?: client.RequestOptions): Promise<GetGameConfigurationResult>

[src]

Gets the configuration of the game.

getGeneratedCodeJob(params: GetGeneratedCodeJobRequest, opts?: client.RequestOptions): Promise<GetGeneratedCodeJobResult>

[src]

Gets details about a job that is generating code for a snapshot.

getPlayerConnectionStatus(params: GetPlayerConnectionStatusRequest, opts?: client.RequestOptions): Promise<GetPlayerConnectionStatusResult>

[src]

Gets the status of a player's connection to the game runtime.

It's possible for a single player to have multiple connections to the game runtime. If a player is not connected, this operation returns an empty list.

getSnapshot(params: GetSnapshotRequest, opts?: client.RequestOptions): Promise<GetSnapshotResult>

[src]

Gets a copy of the game configuration in a snapshot.

getStage(params: GetStageRequest, opts?: client.RequestOptions): Promise<GetStageResult>

[src]

Gets information about a stage.

getStageDeployment(params: GetStageDeploymentRequest, opts?: client.RequestOptions): Promise<GetStageDeploymentResult>

[src]

Gets information about a stage deployment.

importGameConfiguration(params: ImportGameConfigurationRequest, opts?: client.RequestOptions): Promise<ImportGameConfigurationResult>

[src]

Imports a game configuration.

This operation replaces the current configuration of the game with the provided input. This is not a reversible operation. If you want to preserve the previous configuration, use CreateSnapshot to make a new snapshot before importing.

listExtensions(params?: ListExtensionsRequest, opts?: client.RequestOptions): Promise<ListExtensionsResult>

[src]

Gets a paginated list of available extensions.

Extensions provide features that games can use from scripts.

listExtensionVersions(params: ListExtensionVersionsRequest, opts?: client.RequestOptions): Promise<ListExtensionVersionsResult>

[src]

Gets a paginated list of available versions for the extension.

Each time an API change is made to an extension, the version is incremented. The list retrieved by this operation shows the versions that are currently available.

listGames(params?: ListGamesRequest, opts?: client.RequestOptions): Promise<ListGamesResult>

[src]

Gets a paginated list of games.

listGeneratedCodeJobs(params: ListGeneratedCodeJobsRequest, opts?: client.RequestOptions): Promise<ListGeneratedCodeJobsResult>

[src]

Gets a paginated list of code generation jobs for a snapshot.

listSnapshots(params: ListSnapshotsRequest, opts?: client.RequestOptions): Promise<ListSnapshotsResult>

[src]

Gets a paginated list of snapshot summaries from the game.

listStageDeployments(params: ListStageDeploymentsRequest, opts?: client.RequestOptions): Promise<ListStageDeploymentsResult>

[src]

Gets a paginated list of stage deployment summaries from the game.

listStages(params: ListStagesRequest, opts?: client.RequestOptions): Promise<ListStagesResult>

[src]

Gets a paginated list of stage summaries from the game.

listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResult>

[src]

Lists the tags associated with a GameSparks resource.

startGeneratedCodeJob(params: StartGeneratedCodeJobRequest, opts?: client.RequestOptions): Promise<StartGeneratedCodeJobResult>

[src]

Starts an asynchronous process that generates client code for system-defined and custom messages. The resulting code is collected as a .zip file and uploaded to a pre-signed Amazon S3 URL.

startStageDeployment(params: StartStageDeploymentRequest, opts?: client.RequestOptions): Promise<StartStageDeploymentResult>

[src]

Deploys a snapshot to the stage and creates a new game runtime.

After you call this operation, you can check the deployment status by using GetStageDeployment.

If there are any players connected to the previous game runtime, then both runtimes persist. Existing connections to the previous runtime are maintained. When players disconnect and reconnect, they connect to the new runtime. After there are no connections to the previous game runtime, it is deleted.

tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

Adds tags to a GameSparks resource.

untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

Removes tags from a GameSparks resource.

updateGame(params: UpdateGameRequest, opts?: client.RequestOptions): Promise<UpdateGameResult>

[src]

Updates details of the game.

updateGameConfiguration(params: UpdateGameConfigurationRequest, opts?: client.RequestOptions): Promise<UpdateGameConfigurationResult>

[src]

Updates one or more sections of the game configuration.

updateSnapshot(params: UpdateSnapshotRequest, opts?: client.RequestOptions): Promise<UpdateSnapshotResult>

[src]

Updates the metadata of a GameSparks snapshot.

updateStage(params: UpdateStageRequest, opts?: client.RequestOptions): Promise<UpdateStageResult>

[src]

Updates the metadata of a stage.

§Static Properties

ApiMetadata: client.ApiMetadata

[src]