Skip to main content

Commerce.PurchaseResult

Class

Provides an immediate summary of the outcome of a purchase attempt.

  • Snapchat: not supported
  • SPECS: fully supported
  • Camera Kit Web: not supported
  • Camera Kit Mobile: not supported
  • SnapchatNot supported — Available on SPECS only
  • SPECSFully supported
  • Camera Kit WebNot supported — Available on SPECS only
  • Camera Kit MobileNot supported — Available on SPECS only

Platform details

  • Snapchat — Not supported — Available on SPECS only.

  • SPECS — Fully supported.

  • Camera Kit Web — Not supported — Available on SPECS only.

  • Camera Kit Mobile — Not supported — Available on SPECS only.

Provides an immediate summary of the outcome of a purchase attempt. It indicates whether the transaction was successful, canceled by the user, or if an error occurred. This is the first place to look to understand the immediate result of a purchase flow.

Index

Extends

Properties

debugMessage

readonly debugMessage: string

SPECS

If there was an issue with your purchase, this message provides more specific information to help you understand what happened. It’s useful for troubleshooting and diagnosing problems that might occur during the purchase process.


responseCode

readonly responseCode: ResponseCode

SPECS

Tells you if the purchase was successful or if something went wrong. It's like a signal that gives you an immediate update on the transaction's outcome.

Methods

getTypeName()

static getTypeName(): TypeName<PurchaseResult>

SPECS

Returns the fully-qualified JavaScript type name for this class (for example, "Component.Camera"). This is a static accessor (no instance required) and returns the same value as the instance getTypeName().

Returns

TypeName<PurchaseResult>

Overrides

ScriptObject.getTypeName


getTypeName()

getTypeName(): string

Returns the name of this object's type.

Returns

string

Inherited from

ScriptObject.getTypeName


isOfType()

isOfType(type): boolean

Returns true if the object matches or derives from the passed in type.

Parameters

ParameterType
typestring

Returns

boolean

Inherited from

ScriptObject.isOfType


isSame()

isSame(other): boolean

Returns true if this object is the same as other. Useful for checking if two references point to the same thing.

Parameters

ParameterType
otherScriptObject

Returns

boolean

Inherited from

ScriptObject.isSame