Skip to main content

Class: SiteStandardDocumentRecord

Defined in: web/lib/api/generated/index.ts:4696

Constructors​

new SiteStandardDocumentRecord()​

new SiteStandardDocumentRecord(client): SiteStandardDocumentRecord

Defined in: web/lib/api/generated/index.ts:4699

Parameters​

client​

XrpcClient

Returns​

SiteStandardDocumentRecord

Properties​

_client​

_client: XrpcClient

Defined in: web/lib/api/generated/index.ts:4697

Methods​

create()​

create(params, record, headers?): Promise<{ cid: string; uri: string; }>

Defined in: web/lib/api/generated/index.ts:4726

Parameters​

params​

OmitKey<InputSchema, "record" | "collection">

record​

OmitKey<Main>

headers?​

Record<string, string>

Returns​

Promise<{ cid: string; uri: string; }>

delete()​

delete(params, headers?): Promise<void>

Defined in: web/lib/api/generated/index.ts:4762

Parameters​

params​

OmitKey<InputSchema, "collection">

headers?​

Record<string, string>

Returns​

Promise<void>

get()​

get(params): Promise<{ cid: string; uri: string; value: Main; }>

Defined in: web/lib/api/generated/index.ts:4716

Parameters​

params​

OmitKey<QueryParams, "collection">

Returns​

Promise<{ cid: string; uri: string; value: Main; }>

list()​

list(params): Promise<{ cursor: string; records: object[]; }>

Defined in: web/lib/api/generated/index.ts:4703

Parameters​

params​

OmitKey<QueryParams, "collection">

Returns​

Promise<{ cursor: string; records: object[]; }>

put()​

put(params, record, headers?): Promise<{ cid: string; uri: string; }>

Defined in: web/lib/api/generated/index.ts:4744

Parameters​

params​

OmitKey<InputSchema, "record" | "collection">

record​

OmitKey<Main>

headers?​

Record<string, string>

Returns​

Promise<{ cid: string; uri: string; }>