Interface WidgetExportedObject

Represents a server-side object that may not yet have been fetched by the client. When this object will no longer be used, if fetch is not called on this object, then close must be to ensure server-side resources are correctly freed.

Hierarchy

  • WidgetExportedObject

Properties

type?

Methods

close fetch reexport

Properties

Optional Readonly type

type?: string

Returns the type of this export, typically one of VariableType, but may also include plugin types. If null, this object cannot be fetched, but can be passed to the server, such as via sendMessage.

Returns

the string type of this server-side object, or null.

Methods

close

  • Releases the server-side resources associated with this object, regardless of whether other client-side objects exist that also use that object. Should not be called after fetch() has been invoked.

    Returns void

fetch

  • Returns a promise that will fetch the object represented by this reference. Multiple calls to this will return the same instance.

    Returns Promise<any>

    a promise that will resolve to a client side object that represents the reference on the server.

reexport

  • Exports another copy of this reference, allowing it to be fetched separately. Results in rejection if the ticket was already closed (either by calling close or closing the object returned from fetch).

    Returns Promise<WidgetExportedObject>

    a promise returning a reexported copy of this object, still referencing the same server-side object.

Settings

Member Visibility

Theme

On This Page