Skip to main content

PurchaseCap

PurchaseCap​

class PurchaseCap

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

debugDescription​

var debugDescription: String { get }

A textual representation of this instance, suitable for debugging.

Calling this property directly is discouraged. Instead, convert an instance of any type to a string by using the String(reflecting:) initializer. This initializer works with any type, and uses the custom debugDescription property for types that conform to CustomDebugStringConvertible:

struct Point: CustomDebugStringConvertible {
    let x: Int, y: Int

    var debugDescription: String {
        return "(\(x), \(y))"
    }
}

let p = Point(x: 21, y: 30)
let s = String(reflecting: p)
print(s)
// Prints "(21, 30)"

The conversion of p to a string in the assignment to s uses the Point type's debugDescription property.

id()​

func id() -> ObjectId

The object's ID.

itemId()​

func itemId() -> ObjectId

Object ID of the listed item.

kioskId()​

func kioskId() -> ObjectId

Object ID of the kiosk the listed item belongs to.

minPrice()​

func minPrice() -> UInt64

Minimum price the item may be purchased for, in nanos.

tryFromBcs(bytes:)​

static func tryFromBcs(bytes: Data) throws -> PurchaseCap

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

tryFromObjectWithType(object:typeParam:)​

static func tryFromObjectWithType(object: Object, typeParam: TypeTag) throws -> PurchaseCap

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