Class default

Constructors

constructor

new default(): default
Returns default

Methods

`Static` addTitle

addTitle<T>(show_id, data, params?): AxiosPromise<default<T>>
Add a title to a game show by admin.
Type Parameters
- T
Parameters
- show_id: string
- data: object
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
- Defined in api/GameShows.ts:153

`Static` analyticsReport

analyticsReport<T>(show_id, params?): AxiosPromise<default<T>>
Get organizer analytics for a game show.
Type Parameters
- T
Parameters
- show_id: string
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
- Defined in api/GameShows.ts:265

`Static` create

create<T>(data, params?): AxiosPromise<default<T>>
Create a new game show.
Type Parameters
- T
Parameters
- data: object
  The data to be passed when creating a game show.
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
Promise

See
https://api.glitch.fun/api/documentation#/GameShows/createGameShow
- Defined in api/GameShows.ts:28

`Static` createBlock

createBlock<T>(show_id, data, params?): AxiosPromise<default<T>>
Create a page-builder block for a game show. Requires organizer permissions.
Type Parameters
- T
Parameters
- show_id: string
- data: object
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
- Defined in api/GameShows.ts:195

`Static` createScheduleItem

createScheduleItem<T>(show_id, data, params?): AxiosPromise<default<T>>
Create a schedule item for a game show. Requires organizer permissions.
Type Parameters
- T
Parameters
- show_id: string
- data: object
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
- Defined in api/GameShows.ts:230

`Static` delete

delete<T>(show_id, params?): AxiosPromise<default<T>>
Deletes a game show.
Type Parameters
- T
Parameters
- show_id: string
  The id of the game show to delete.
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
promise

See
https://api.glitch.fun/api/documentation#/GameShows/deleteGameShow
- Defined in api/GameShows.ts:70

`Static` deleteBlock

deleteBlock<T>(show_id, block_id, params?): AxiosPromise<default<T>>
Delete a page-builder block from a game show. Requires organizer permissions.
Type Parameters
- T
Parameters
- show_id: string
- block_id: string
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
- Defined in api/GameShows.ts:209

`Static` deleteScheduleItem

deleteScheduleItem<T>(show_id, schedule_id, params?): AxiosPromise<default<T>>
Delete a schedule item from a game show. Requires organizer permissions.
Type Parameters
- T
Parameters
- show_id: string
- schedule_id: string
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
- Defined in api/GameShows.ts:244

`Static` deleteTitle

deleteTitle<T>(show_id, title_id, params?): AxiosPromise<default<T>>
Delete a specific title from a game show.
Type Parameters
- T
Parameters
- show_id: string
- title_id: string
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
- Defined in api/GameShows.ts:181

`Static` discoveryQueue

discoveryQueue<T>(show_id, params?): AxiosPromise<default<T>>
Get the game show discovery queue.
Type Parameters
- T
Parameters
- show_id: string
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
- Defined in api/GameShows.ts:251

`Static` getTitle

getTitle<T>(show_id, title_id, params?): AxiosPromise<default<T>>
Get details of a specific title in a game show.
Type Parameters
- T
Parameters
- show_id: string
- title_id: string
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
- Defined in api/GameShows.ts:167

`Static` joinWishlist

joinWishlist<T>(show_id, data, params?): AxiosPromise<default<T>>
Join or update a public notification signup for a game show.
Type Parameters
- T
Parameters
- show_id: string
- data: object
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
- Defined in api/GameShows.ts:272

`Static` list

list<T>(params?): AxiosPromise<default<T>>
List all the GameShows.
Type Parameters
- T
Parameters
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
promise

See
https://api.glitch.fun/api/documentation#/GameShows/getGameShows
- Defined in api/GameShows.ts:15

`Static` listBlocks

listBlocks<T>(show_id, params?): AxiosPromise<default<T>>
List public page-builder blocks for a game show.
Type Parameters
- T
Parameters
- show_id: string
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
- Defined in api/GameShows.ts:188

`Static` listForTitle

listForTitle<T>(title_id, params?): AxiosPromise<default<T>>
List public game shows that include a title. Useful for game-page festival banners.
Type Parameters
- T
Parameters
- title_id: string
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
- Defined in api/GameShows.ts:286

`Static` listSchedule

listSchedule<T>(show_id, params?): AxiosPromise<default<T>>
List livestream and programming schedule items for a game show.
Type Parameters
- T
Parameters
- show_id: string
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
- Defined in api/GameShows.ts:223

`Static` listTitles

listTitles<T>(show_id, params?): AxiosPromise<default<T>>
List all titles for a game show.
Type Parameters
- T
Parameters
- show_id: string
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
- Defined in api/GameShows.ts:160

`Static` listWishlist

listWishlist<T>(show_id, params?): AxiosPromise<default<T>>
List notification signups for a game show. Requires organizer permissions.
Type Parameters
- T
Parameters
- show_id: string
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
- Defined in api/GameShows.ts:279

`Static` registerTitle

registerTitle<T>(show_id, data, params?): AxiosPromise<default<T>>
Register a title to a game show.
Type Parameters
- T
Parameters
- show_id: string
- data: object
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
- Defined in api/GameShows.ts:146

`Static` reorderBlocks

reorderBlocks<T>(show_id, data, params?): AxiosPromise<default<T>>
Reorder page-builder blocks for a game show. Requires organizer permissions.
Type Parameters
- T
Parameters
- show_id: string
- data: object
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
- Defined in api/GameShows.ts:216

`Static` trackAnalytics

trackAnalytics<T>(show_id, data, params?): AxiosPromise<default<T>>
Track public game show analytics events.
Type Parameters
- T
Parameters
- show_id: string
- data: object
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
- Defined in api/GameShows.ts:258

`Static` update

update<T>(show_id, data, params?): AxiosPromise<default<T>>
Update a game show.
Type Parameters
- T
Parameters
- show_id: string
  The id of the game show to update.
- data: object
  The data to update.
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
promise

See
https://api.glitch.fun/api/documentation#/GameShows/updateGameShow
- Defined in api/GameShows.ts:43

`Static` updateBlock

updateBlock<T>(show_id, block_id, data, params?): AxiosPromise<default<T>>
Update a page-builder block for a game show. Requires organizer permissions.
Type Parameters
- T
Parameters
- show_id: string
- block_id: string
- data: object
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
- Defined in api/GameShows.ts:202

`Static` updateScheduleItem

updateScheduleItem<T>(show_id, schedule_id, data, params?): AxiosPromise<default<T>>
Update a schedule item for a game show. Requires organizer permissions.
Type Parameters
- T
Parameters
- show_id: string
- schedule_id: string
- data: object
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
- Defined in api/GameShows.ts:237

`Static` updateTitle

updateTitle<T>(show_id, title_id, data, params?): AxiosPromise<default<T>>
Update a specific title in a game show.
Type Parameters
- T
Parameters
- show_id: string
- title_id: string
- data: object
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
- Defined in api/GameShows.ts:174

`Static` uploadBannerImageBlob

uploadBannerImageBlob<T>(show_id, blob, data?, params?): AxiosPromise<default<T>>
Updates the banner image for the game show using a Blob.
Type Parameters
- T
Parameters
- show_id: string
- blob: Blob
  The blob to upload.
- Optional data: object
  Any additional data to pass along to the upload
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
promise

See
https://api.glitch.fun/api/documentation#/GameShows/uploadGameShowBannerImage
- Defined in api/GameShows.ts:136

`Static` uploadBannerImageFile

uploadBannerImageFile<T>(show_id, file, data?, params?): AxiosPromise<default<T>>
Updates the banner image for the game show using a File object.
Type Parameters
- T
Parameters
- show_id: string
- file: File
  The file object to upload.
- Optional data: object
  Any additional data to pass along to the upload.
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
promise

See
https://api.glitch.fun/api/documentation#/GameShows/uploadGameShowBannerImage
- Defined in api/GameShows.ts:119

`Static` uploadLogoBlob

uploadLogoBlob<T>(show_id, blob, data?, params?): AxiosPromise<default<T>>
Updates the main image for the game show using a Blob.
Type Parameters
- T
Parameters
- show_id: string
- blob: Blob
  The blob to upload.
- Optional data: object
  Any additional data to pass along to the upload
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
promise

See
https://api.glitch.fun/api/documentation#/GameShows/uploadGameShowLogo
- Defined in api/GameShows.ts:102

`Static` uploadLogoFile

uploadLogoFile<T>(show_id, file, data?, params?): AxiosPromise<default<T>>
Updates the main image for the game show using a File object.
Type Parameters
- T
Parameters
- show_id: string
- file: File
  The file object to upload.
- Optional data: object
  Any additional data to pass along to the upload.
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
promise

See
https://api.glitch.fun/api/documentation#/GameShows/uploadGameShowLogo
- Defined in api/GameShows.ts:85

`Static` view

view<T>(show_id, params?): AxiosPromise<default<T>>
Retrieve the information for a single game show.
Type Parameters
- T
Parameters
- show_id: string
  The id fo the game show to retrieve.
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
promise

See
https://api.glitch.fun/api/documentation#/GameShows/getGameShowByUuid
- Defined in api/GameShows.ts:57

Class default

Index

Constructors

Methods

Constructors

constructor

Returns default

Methods

Static addTitle

Type Parameters

T

Parameters

show_id: string

data: object

Optional params: Record<string, any>

Returns AxiosPromise<default<T>>

Static analyticsReport

Type Parameters

T

Parameters

show_id: string

Optional params: Record<string, any>

Returns AxiosPromise<default<T>>

Static create

Type Parameters

T

Parameters

data: object

Optional params: Record<string, any>

Returns AxiosPromise<default<T>>

See

Static createBlock

Type Parameters

T

Parameters

show_id: string

data: object

Optional params: Record<string, any>

Returns AxiosPromise<default<T>>

Static createScheduleItem

Type Parameters

T

Parameters

show_id: string

data: object

Optional params: Record<string, any>

Returns AxiosPromise<default<T>>

Static delete

Type Parameters

T

Parameters

show_id: string

Optional params: Record<string, any>

Returns AxiosPromise<default<T>>

See

Static deleteBlock

Type Parameters

T

Parameters

show_id: string

block_id: string

Optional params: Record<string, any>

Returns AxiosPromise<default<T>>

Static deleteScheduleItem

Type Parameters

T

Parameters

show_id: string

schedule_id: string

Optional params: Record<string, any>

Returns AxiosPromise<default<T>>

Static deleteTitle

Type Parameters

T

Parameters

show_id: string

title_id: string

Optional params: Record<string, any>

Returns AxiosPromise<default<T>>

Static discoveryQueue

`Static` addTitle

`Optional` params: Record<string, any>

`Static` analyticsReport

`Optional` params: Record<string, any>

`Static` create

`Optional` params: Record<string, any>

`Static` createBlock

`Optional` params: Record<string, any>

`Static` createScheduleItem

`Optional` params: Record<string, any>

`Static` delete

`Optional` params: Record<string, any>

`Static` deleteBlock

`Optional` params: Record<string, any>

`Static` deleteScheduleItem

`Optional` params: Record<string, any>

`Static` deleteTitle

`Optional` params: Record<string, any>

`Static` discoveryQueue

`Optional` params: Record<string, any>

`Static` getTitle

`Optional` params: Record<string, any>

`Static` joinWishlist

`Optional` params: Record<string, any>

`Static` list

`Optional` params: Record<string, any>

`Static` listBlocks

`Optional` params: Record<string, any>

`Static` listForTitle

`Optional` params: Record<string, any>

`Static` listSchedule

`Optional` params: Record<string, any>

`Static` listTitles

`Optional` params: Record<string, any>

`Static` listWishlist

`Optional` params: Record<string, any>

`Static` registerTitle