Class RemoteObjectRef

constructor

• new RemoteObjectRef(client: Client, type: string, key: string): RemoteObjectRef

  Parameters

  • client: Client
  • type: string
  • key: string

  Returns RemoteObjectRef

Readonlykey

Readonlytype

id

• get id(): string

  Returns string

call

• call<R = unknown, A = unknown>(
      handler: string,
      arg?: A,
      opts?: CallOptions,
  ): Promise<R>

  Type Parameters

  • R = unknown
  • A = unknown

  Parameters

  • handler: string
  • Optionalarg: A
  • opts: CallOptions = {}

  Returns Promise<R>

clearState

• clearState(field?: string, opts?: EditOptions): Promise<EditResult>

  Parameters

  • Optionalfield: string
  • opts: EditOptions = {}

  Returns Promise<EditResult>

editState

• editState(edit: StateEdit, opts?: EditOptions): Promise<EditResult>

  Parameters

  • edit: StateEdit
  • opts: EditOptions = {}

  Returns Promise<EditResult>

patchState

• patchState(ops: JsonPatchOp[], opts?: EditOptions): Promise<EditResult>

  Parameters

  • ops: JsonPatchOp[]
  • opts: EditOptions = {}

  Returns Promise<EditResult>

send

• send<A = unknown>(handler: string, arg?: A, opts?: CallOptions): Promise<void>

  Type Parameters

  • A = unknown

  Parameters

  • handler: string
  • Optionalarg: A
  • opts: CallOptions = {}

  Returns Promise<void>

setState

• setState(field: string, value: unknown, opts?: EditOptions): Promise<EditResult>

  Parameters

  • field: string
  • value: unknown
  • opts: EditOptions = {}

  Returns Promise<EditResult>

state

• state<T = Record<string, unknown>>(): Promise<T>

  Type Parameters

  • T = Record<string, unknown>

  Returns Promise<T>