Skip to main content

Class: Display

A typed view of an on-chain 0x2::display::Display<T> object.

Extends​

  • UniffiAbstractObject

Implements​

Properties​

[destructorGuardSymbol]​

readonly [destructorGuardSymbol]: UniffiGcObject;

[pointerLiteralSymbol]​

readonly [pointerLiteralSymbol]: bigint;

[uniffiTypeNameSymbol]​

readonly [uniffiTypeNameSymbol]: "Display" = "Display";

Methods​

fields()​

fields(): Map<string, string>;

The display template as key/value pairs (e.g. name, link, image_url, description).

Returns​

Map<string, string>

Implementation of​

DisplayLike.fields


id()​

id(): ObjectIdLike;

The object's ID.

Returns​

ObjectIdLike

Implementation of​

DisplayLike.id


toDebugString()​

toDebugString(): string;

Returns​

string


toString()​

toString(): string;

Returns a string representation of an object.

Returns​

string


uniffiDestroy()​

uniffiDestroy(): void;

Explicitly tell Rust to destroy the native peer that backs this object.

Once this method has been called, any following method calls will throw an error.

Can be called more than once.

Returns​

void

Overrides​

UniffiAbstractObject.uniffiDestroy

uniffiUse()​

uniffiUse<T>(block): T;

A convenience method to use this object, then destroy it after its use.

Type Parameters​

T​

T

Parameters​

block​

(obj) => T

Returns​

T

Inherited from​

UniffiAbstractObject.uniffiUse

version()​

version(): number;

Version, bumped manually by the publisher on each update.

Returns​

number

Implementation of​

DisplayLike.version


instanceOf()​

static instanceOf(obj_): obj_ is Display;

Parameters​

obj_​

any

Returns​

obj_ is Display


tryFromBcs()​

static tryFromBcs(bytes): DisplayLike;

Decode from BCS bytes, without validating the on-chain type tag.

Parameters​

bytes​

ArrayBuffer

Returns​

DisplayLike


tryFromObjectWithType()​

static tryFromObjectWithType(object, typeParam): DisplayLike;

Decode from an on-chain object, validating its Move type tag, including that its type parameter equals type_param.

Parameters​

object​

ObjectLike

typeParam​

TypeTagLike

Returns​

DisplayLike