Class SDKApps

Class providing methods for working with Apps

Index

Constructors

Methods

create delete get getCommon getDocs getIcon getSection list makePrivate makePublic setCommon setDocs setIcon setSection update

Constructors

constructor

new SDKApps(fetch: FetchFunction): SDKApps
Parameters
- fetch: FetchFunction
Returns SDKApps
- Defined in src/endpoints/sdk/apps.ts:184

Methods

create

create(
    body: CreateSDKAppBody,
): Promise<
    Pick<
        SDKApp,
        | "name"
        | "public"
        | "description"
        | "theme"
        | "label"
        | "version"
        | "approved",
    >,
>
Create a new app
Parameters
- body: CreateSDKAppBody
Returns Promise<
    Pick<
        SDKApp,
        | "name"
        | "public"
        | "description"
        | "theme"
        | "label"
        | "version"
        | "approved",
    >,
>
- Defined in src/endpoints/sdk/apps.ts:215

delete

delete(name: string, version: number): Promise<void>
Delete an app
Parameters
- name: string
- version: number
Returns Promise<void>
- Defined in src/endpoints/sdk/apps.ts:237

get

get<C extends keyof SDKApp = never>(
    name: string,
    version: number,
    options?: GetSDKAppsOptions<C>,
): Promise<PickColumns<SDKApp, C>>
Get a single app by name and version
Type Parameters
- C extends keyof SDKApp = never
Parameters
- name: string
- version: number
- options: GetSDKAppsOptions<C> = {}
Returns Promise<PickColumns<SDKApp, C>>
- Defined in src/endpoints/sdk/apps.ts:201

getCommon

getCommon(name: string, version: number): Promise<SDKAppCommon>
Get app common data (client credentials and shared configuration)
Parameters
- name: string
- version: number
Returns Promise<SDKAppCommon>
- Defined in src/endpoints/sdk/apps.ts:291

getDocs

getDocs(name: string, version: number): Promise<string>
Get app documentation (readme)
Parameters
- name: string
- version: number
Returns Promise<string>
- Defined in src/endpoints/sdk/apps.ts:269

getIcon

getIcon(name: string, version: number, size?: number): Promise<ArrayBuffer>
Download an app icon at a given rendered size.
Parameters
- name: string
- version: number
- size: number = 512
Returns Promise<ArrayBuffer>
- Defined in src/endpoints/sdk/apps.ts:325

getSection

getSection(
    name: string,
    version: number,
    section: SDKAppSectionType,
): Promise<string>
Get a specific section of an app Available sections: base, groups, install, installSpec
Parameters
- name: string
- version: number
- section: SDKAppSectionType
Returns Promise<string>
- Defined in src/endpoints/sdk/apps.ts:247

list

list<C extends keyof SDKApp = never>(
options?: ListSDKAppsOptions<C>,
): Promise<PickColumns<SDKApp, C>[]>
List apps with optional filtering
Type Parameters
- C extends keyof SDKApp = never
Parameters
- options: ListSDKAppsOptions<C> = {}
Returns Promise<PickColumns<SDKApp, C>[]>
- Defined in src/endpoints/sdk/apps.ts:191

makePrivate

makePrivate(name: string, version: number): Promise<void>
Make app private.
Parameters
- name: string
- version: number
Returns Promise<void>
- Defined in src/endpoints/sdk/apps.ts:332

makePublic

makePublic(name: string, version: number): Promise<void>
Make app public.
Parameters
- name: string
- version: number
Returns Promise<void>
- Defined in src/endpoints/sdk/apps.ts:341

setCommon

setCommon(name: string, version: number, common: SDKAppCommon): Promise<boolean>
Set app common data (client credentials and shared configuration)
Parameters
- name: string
- version: number
- common: SDKAppCommon
Returns Promise<boolean>
- Defined in src/endpoints/sdk/apps.ts:299

setDocs

setDocs(name: string, version: number, docs: string): Promise<boolean>
Set app documentation (readme)
Parameters
- name: string
- version: number
- docs: string
Returns Promise<boolean>
- Defined in src/endpoints/sdk/apps.ts:277

setIcon

setIcon(
    name: string,
    version: number,
    iconData: ArrayBuffer | Uint8Array<ArrayBufferLike>,
): Promise<boolean>
Upload an app icon. The icon must be a 512x512 PNG; otherwise an error is thrown before upload.
Parameters
- name: string
- version: number
- iconData: ArrayBuffer | Uint8Array<ArrayBufferLike>
Returns Promise<boolean>
- Defined in src/endpoints/sdk/apps.ts:310

setSection

setSection(
    name: string,
    version: number,
    section: SDKAppSectionType,
    body: string,
): Promise<void>
Set/update a specific section of an app Available sections: base, groups, install, installSpec
Parameters
- name: string
- version: number
- section: SDKAppSectionType
- body: string
Returns Promise<void>
- Defined in src/endpoints/sdk/apps.ts:256

update

update(
    name: string,
    version: number,
    body: UpdateSDKAppBody,
): Promise<
    Pick<
        SDKApp,
        | "name"
        | "public"
        | "description"
        | "theme"
        | "label"
        | "version"
        | "approved",
    >,
>
Update an existing app
Parameters
- name: string
- version: number
- body: UpdateSDKAppBody
Returns Promise<
    Pick<
        SDKApp,
        | "name"
        | "public"
        | "description"
        | "theme"
        | "label"
        | "version"
        | "approved",
    >,
>
- Defined in src/endpoints/sdk/apps.ts:226

Class SDKApps

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns SDKApps

Methods

create

Parameters

Returns Promise< Pick< SDKApp, | "name" | "public" | "description" | "theme" | "label" | "version" | "approved", >,>

delete

Parameters

Returns Promise<void>

get

Type Parameters

Parameters

Returns Promise<PickColumns<SDKApp, C>>

getCommon

Parameters

Returns Promise<SDKAppCommon>

getDocs

Parameters

Returns Promise<string>

getIcon

Parameters

Returns Promise<ArrayBuffer>

getSection

Parameters

Returns Promise<string>

list

Type Parameters

Parameters

Returns Promise<PickColumns<SDKApp, C>[]>

makePrivate

Parameters

Returns Promise<void>

makePublic

Parameters

Returns Promise<void>

setCommon

Parameters

Returns Promise<boolean>

setDocs

Parameters

Returns Promise<boolean>

setIcon

Parameters

Returns Promise<boolean>

setSection

Parameters

Returns Promise<void>

update

Parameters

Returns Promise< Pick< SDKApp, | "name" | "public" | "description" | "theme" | "label" | "version" | "approved", >,>

Settings

On This Page

Returns Promise<
Pick<
SDKApp,
| "name"
| "public"
| "description"
| "theme"
| "label"
| "version"
| "approved",
>,
>

Returns Promise<
Pick<
SDKApp,
| "name"
| "public"
| "description"
| "theme"
| "label"
| "version"
| "approved",
>,
>