Interface ProductGrantResultItem

A readonly type that represents the result of a product grant operation performed using PlayerHandle.requestGrantProduct and ClusterScript.onRequestGrantProductResult.

Hierarchy

  • ProductGrantResult

Properties

errorReason meta player productId productName status

Properties

Readonly errorReason

errorReason: string

A string indicating the reason for failure when status is "Unknown" or "Failed".

Returns null for other status values.

Readonly meta

meta: string

The meta string specified in PlayerHandle.requestGrantProduct.

Readonly player

player: PlayerHandle

The PlayerHandle of the player who was granted the product.

Readonly productId

productId: string

The ID of the granted product.

Readonly productName

productName: string

The name of the granted product.

Readonly status

status: ProductGrantStatus

A string indicating the result of the product grant request.

  • "Unknown" .. Indicates that it cannot be determined whether the grant was performed due to reasons such as network errors.
  • "Granted" .. Indicates that the product was granted to the player.
  • "AlreadyOwned" .. Indicates that the player already owned the product.
  • "Failed" .. Indicates that an attempt was made to grant the product, but the grant failed.

Settings

Member Visibility

Theme

Generated using TypeDoc