Five On It

Appearance

five-on-it / apps/client/src/ui/admin / adminApi

Function: adminApi() ​

adminApi(platform): object

Defined in: apps/client/src/ui/admin.ts:152

The admins' calls, as the page's session.

Parameters ​

platform ​

Platform

Returns ​

object

account ​

account: (id) => Promise<AdminAccount>

Parameters ​

id ​

string

Returns ​

Promise<AdminAccount>

audit ​

audit: () => Promise<AdminChange[]>

Returns ​

Promise<AdminChange[]>

cancel ​

cancel: (job) => Promise<Creation>

Parameters ​

job ​

string

Returns ​

Promise<Creation>

creations ​

creations: () => Promise<AdminCreations>

Returns ​

Promise<AdminCreations>

overrides ​

overrides: () => Promise<AdminOverride[]>

Returns ​

Promise<AdminOverride[]>

reset ​

reset: (id) => Promise<AdminAccount>

Parameters ​

id ​

string

Returns ​

Promise<AdminAccount>

search: (q) => Promise<AdminAccount[]>

Parameters ​

q ​

string

Returns ​

Promise<AdminAccount[]>

set ​

set: (id, form) => Promise<AdminAccount>

Parameters ​

id ​

string

form ​

LimitsForm

Returns ​

Promise<AdminAccount>