Documentation / @imvu/client / RemoteDocument

Abstract Class: RemoteDocument

Defined in: packages/client/src/resources/RemoteDocument.ts:7

Shared state for any remotely addressable node, edge, or collection document.

Extended by

• Resource
• Collection

Constructors

Constructor

protected new RemoteDocument(client, url?): RemoteDocument;

Defined in: packages/client/src/resources/RemoteDocument.ts:15

Parameters

Parameter	Type	Default value
client	Client	undefined
url?	string	''

Returns

RemoteDocument

Properties

_url

protected _url: string = '';

Defined in: packages/client/src/resources/RemoteDocument.ts:13

---

client

protected readonly client: Client;

Defined in: packages/client/src/resources/RemoteDocument.ts:16

---

revision

revision: number = 0;

Defined in: packages/client/src/resources/RemoteDocument.ts:8

---

stale

stale: boolean = false;

Defined in: packages/client/src/resources/RemoteDocument.ts:9

---

updateTarget

updateTarget: 
  | APIUpdateTarget
  | null
  | undefined;

Defined in: packages/client/src/resources/RemoteDocument.ts:11

Undefined until metadata is loaded; null means the API explicitly provides no update target.

Accessors

url

Get Signature

get url(): string;

Defined in: packages/client/src/resources/RemoteDocument.ts:28

Canonical REST URL and cache identity for this document.

Returns

string

Methods

_applyRemoteMetadata()

_applyRemoteMetadata(url, updateTarget): void;

Defined in: packages/client/src/resources/RemoteDocument.ts:33

Internal

Apply address/update metadata from an authoritative REST response.

Parameters

Parameter	Type
url	string
updateTarget	APIUpdateTarget | null

Returns

void

---

_invalidate()

_invalidate(): void;

Defined in: packages/client/src/resources/RemoteDocument.ts:40

Internal

Mark this document stale after an IMQ invalidation.

Returns

void

---

watch()

watch(): Promise<DocumentWatch<RemoteDocument>>;

Defined in: packages/client/src/resources/RemoteDocument.ts:46

Observe explicit IMQ invalidations for this document.

Returns

Promise<DocumentWatch<RemoteDocument>>