Structs§
- AllTransactions
- Bevy
IosIap - Bevy
IosIap Request Builder - Current
Entitlements - Finish
Transaction - IosIap
Currency - Used in
IosIapTransaction
- IosIap
Plugin - Bevy plugin to integrate access to iOS StoreKit2
- IosIap
Product - Expected event data in response to
get_products
method call. - IosIap
Storefront - The App Store storefront associated with the transaction.
- IosIap
Subscription Info - Expected event data in response to
get_products
method call. - IosIap
Subscription Period - Used in
IosIapSubscriptionInfo
- IosIap
Subscription Status - Used in
IosIapSubscriptionInfo
- IosIap
Transaction - Representation of a Transaction. Mirrors the Transcation type in Apple’s StoreKit2 closely. See official docs for more details on the individual fields.
- Products
- Purchase
Enums§
- IosIap
Environment - The server environment that generates and signs the transaction.
- IosIap
Events - Events for pro-active communication from native iOS (Swift) side to Rust/Bevy that are not a direct response to a request.
- IosIap
Product Type - The type of the in-app purchase.
- IosIap
Products Response - Expected event data in response to [
get_products
] method call. - IosIap
Purchase Error - Used in
IosIapPurchaseResponse
- IosIap
Purchase Response - Expected event data in response to [
purchase
] method call. - IosIap
Response - All possible responses for communication from the native iOS (Swift) side to Rust/Bevy as a reaction to a method call / request.
- IosIap
Revocation Reason - Used in
IosIapTransaction
- IosIap
Store KitError - Used in
IosIapPurchaseResponse
- IosIap
Subscription Period Unit - Used in
IosIapSubscriptionPeriod
- IosIap
Subscription Renewal State - Used in
IosIapSubscriptionStatus
- IosIap
Transaction Finish Response - Expected event data in response to [
finish_transaction
] method call. - IosIap
Transaction Reason - A cause of a purchase transaction, indicating whether it’s a customer’s purchase or an auto-renewable subscription renewal that the system initiates.
- IosIap
Transaction Response - Expected event data in response to [
current_entitlements
] or [all_transactions
] method call.
Functions§
- all_
transactions - Quoted from Apple’s docs: “A sequence that emits all the transactions for the user for your app.”
- current_
entitlements - Quoted from Apple docs: “A sequence of the latest transactions that entitle a user to in-app purchases and subscriptions.”
- finish_
transaction - Finishes a Transaction. Identify the Transaction with an ID.
Apple expects us to call this only after the user got the Product granted so we can safely consider this purchase finished.
Until the transaction is finished iOS will keep triggering it as soon as we register the
TransactionObserver via the
init
call. Seecrate::init
. - get_
products - Fetch Product Details. A list of Product IDs has to be provided.
Expected to be confirmed with event: [
IosIapEvents::Products
][crate::IosIapEvents::Products] - init
- Registers for any updates on Transactions.
Any such update will trigger:
IosIapEvents::TransactionUpdate
- purchase
- Trigger a purchase flow. The product ID has to be provided
Expected to be confirmed with event: [
IosIapEvents::Purchase
][crate::IosIapEvents::Purchase]