Skip to main content

ReceiptProcessingService

Centralize receipt processing within games since this is a constrained resource.

Functions​

SetDefaultPurchaseDecision​

</>
ReceiptProcessingService:SetDefaultPurchaseDecision(productPurchaseDecision: ProductPurchaseDecision) → ()

Sets the default purchase decision in case you want more control

ObserveReceiptProcessedForPlayer​

</>
ReceiptProcessingService:ObserveReceiptProcessedForPlayer(player: Player) → Observable<ReceiptInfo>

Observes receipt by player

ObserveReceiptProcessedForUserId​

</>
ReceiptProcessingService:ObserveReceiptProcessedForUserId(userId: number) → Observable<ReceiptInfo>

Observes receipt by userId

RegisterReceiptProcessor​

</>
ReceiptProcessingService:RegisterReceiptProcessor(
processor: (receiptInfo) → ProductPurchaseDecision | Promise<ProductPurchaseDecision> | nil,
priority: number
) → ()

Registers a new receipt processor. This works exactly like a normal receipt processor except it will also take a Promise as a result (of which an error).

Show raw api
{
    "functions": [
        {
            "name": "SetDefaultPurchaseDecision",
            "desc": "Sets the default purchase decision in case you want more control",
            "params": [
                {
                    "name": "productPurchaseDecision",
                    "desc": "",
                    "lua_type": "ProductPurchaseDecision"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 51,
                "path": "src/receiptprocessing/src/Server/ReceiptProcessingService.lua"
            }
        },
        {
            "name": "ObserveReceiptProcessedForPlayer",
            "desc": "Observes receipt by player",
            "params": [
                {
                    "name": "player",
                    "desc": "",
                    "lua_type": "Player"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<ReceiptInfo>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 63,
                "path": "src/receiptprocessing/src/Server/ReceiptProcessingService.lua"
            }
        },
        {
            "name": "ObserveReceiptProcessedForUserId",
            "desc": "Observes receipt by userId",
            "params": [
                {
                    "name": "userId",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<ReceiptInfo>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 74,
                "path": "src/receiptprocessing/src/Server/ReceiptProcessingService.lua"
            }
        },
        {
            "name": "RegisterReceiptProcessor",
            "desc": "Registers a new receipt processor. This works exactly like a normal receipt processor except it will also\ntake a Promise as a result (of which an error).",
            "params": [
                {
                    "name": "processor",
                    "desc": "",
                    "lua_type": "(receiptInfo) -> ProductPurchaseDecision | Promise<ProductPurchaseDecision> | nil"
                },
                {
                    "name": "priority",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 87,
                "path": "src/receiptprocessing/src/Server/ReceiptProcessingService.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "ReceiptProcessingService",
    "desc": "Centralize receipt processing within games since this is a constrained resource.",
    "source": {
        "line": 6,
        "path": "src/receiptprocessing/src/Server/ReceiptProcessingService.lua"
    }
}