Skip to main content

Class: TransferPolicyCap

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

Extends

  • UniffiAbstractObject

Implements

Properties

[destructorGuardSymbol]

readonly [destructorGuardSymbol]: UniffiGcObject;

[pointerLiteralSymbol]

readonly [pointerLiteralSymbol]: bigint;

[uniffiTypeNameSymbol]

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

Methods

id()

id(): ObjectIdLike;

The object's ID.

Returns

ObjectIdLike

Implementation of

TransferPolicyCapLike.id


policyId()

policyId(): ObjectIdLike;

Object ID of the TransferPolicy this cap controls.

Returns

ObjectIdLike

Implementation of

TransferPolicyCapLike.policyId


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

instanceOf()

static instanceOf(obj_): obj_ is TransferPolicyCap;

Parameters

obj_

any

Returns

obj_ is TransferPolicyCap


tryFromBcs()

static tryFromBcs(bytes): TransferPolicyCapLike;

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

Parameters

bytes

ArrayBuffer

Returns

TransferPolicyCapLike


tryFromObjectWithType()

static tryFromObjectWithType(object, typeParam): TransferPolicyCapLike;

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

TransferPolicyCapLike