Add RN VC Docs (#1006)

Author: fire-at-will

code_blocks/virtual-currency/vc-balance-sdk-android.java

@@ -14,7 +14,7 @@ public void onError(@NonNull PurchasesError error) {
 );
 
 // Get the details of a specific virtual currency
-VirtualCurrency virtualCurrency = virtualCurrencies.getAll().get("");
+VirtualCurrency virtualCurrency = virtualCurrencies.getAll().get(<virtual_currency_code>);
 int balance = virtualCurrency.getBalance();
 String name = virtualCurrency.getName();
 String code = virtualCurrency.getCode();
@@ -23,7 +23,7 @@ public void onError(@NonNull PurchasesError error) {
 // in the RevenueCat dashboard
 String serverDescription = virtualCurrency.getServerDescription();
 
-// Iterate through all virtual currency balances
+// Iterate through all virtual currencies
 virtualCurrencies.getAll().forEach((key, virtualCurrency) -> {
     System.out.println(virtualCurrency.getCode() + ": " + virtualCurrency.getBalance());
 });

code_blocks/virtual-currency/vc-balance-sdk-android.kt

@@ -22,9 +22,12 @@ val virtualCurrency = virtualCurrencies.all[<your_virtual_currency_code>]
 val balance = virtualCurrency?.balance
 val name = virtualCurrency?.name
 val code = virtualCurrency?.code
+
+// Keep in mind that serverDescription may be null if no description was provided
+// in the RevenueCat dashboard
 val description = virtualCurrency?.serverDescription
 
-// Iterate through all virtual currency balances
+// Iterate through all virtual currencies
 for ((virtualCurrencyCode, virtualCurrency) in virtualCurrencies.all) {
     println("$virtualCurrencyCode: ${virtualCurrency.balance}")
 }

code_blocks/virtual-currency/vc-balance-sdk-ios.swift

@@ -4,17 +4,20 @@ let virtualCurrencies = try? await Purchases.shared.virtualCurrencies()
 
 // With Completion Handlers
 Purchases.shared.virtualCurrencies { virtualCurrencies, error in
-
+   // TODO: Handle virtual currencies & error
 }
 
 // Get the details of a specific virtual currency
 let virtualCurrency = virtualCurrencies.all[<your_virtual_currency_code>]
 let balance = virtualCurrency?.balance
 let name = virtualCurrency?.name
 let code = virtualCurrency?.code
+
+// Keep in mind that serverDescription may be null if no description was provided
+// in the RevenueCat dashboard
 let description = virtualCurrency?.serverDescription
 
-// Iterate through all virtual currency balances
+// Iterate through all virtual currencies
 for(virtualCurrencyCode, virtualCurrencyInfo) in virtualCurrencies.all {
    print("\(virtualCurrencyCode): \(virtualCurrencyInfo.balance)")
 }

code_blocks/virtual-currency/vc-balance-sdk-react-native.ts

@@ -0,0 +1,22 @@
+// Fetch virtual currencies
+try {
+  const virtualCurrencies = await Purchases.getVirtualCurrencies();
+  // TODO: Handle virtual currencies
+} catch (error) {
+  // TODO: Handle error
+}
+
+// Get the details of a specific virtual currency
+const virtualCurrency = virtualCurrencies.all['<virtual_currency_code>'];
+const balance = virtualCurrency.balance;
+const name = virtualCurrency.name;
+const code = virtualCurrency.code;
+
+// Keep in mind that serverDescription may be null if no description was provided
+// in the RevenueCat dashboard
+const serverDescription = virtualCurrency.serverDescription;
+
+// Iterate through all virtual currencies
+for (const [virtualCurrencyCode, virtualCurrency] of Object.entries(virtualCurrencies.all)) {
+    console.log(`${virtualCurrency.code}: ${virtualCurrency.balance}`);
+}

docs/offerings/virtual-currency.mdx

@@ -95,13 +95,15 @@ import content5 from "@site/code_blocks/virtual-currency/balance-response.json?r
 import fetchVCBalancesSwift from "@site/code_blocks/virtual-currency/vc-balance-sdk-ios.swift?raw";
 import fetchVCBalancesKotlin from "@site/code_blocks/virtual-currency/vc-balance-sdk-android.kt?raw";
 import fetchVCBalancesJava from "@site/code_blocks/virtual-currency/vc-balance-sdk-android.java?raw";
+import fetchVCBalancesReactNative from "@site/code_blocks/virtual-currency/vc-balance-sdk-react-native.ts?raw";
 
 Fetching virtual currency balances is supported in the following SDK versions:
 
-| SDK         | Supported Versions |
-|-------------|--------------------|
-| iOS SDK     | 5.32.0+            |
-| Android SDK | 9.1.0+             |
+| SDK              | Supported Versions |
+|------------------|--------------------|
+| iOS SDK          | 5.32.0+            |
+| Android SDK      | 9.1.0+             |
+| React Native SDK | 9.1.0+             |
 
 You can use the `virtualCurrencies()` function to retrieve a customer's balance. The function returns a `VirtualCurrencies` object, which includes the customer's balances along with each virtual currency's metadata.
 
@@ -122,11 +124,18 @@ You can use the `virtualCurrencies()` function to retrieve a customer's balance.
       content: fetchVCBalancesJava,
       name: "Java",
     },
+    {
+      type: "ts",
+      title: "React Native",
+      content: fetchVCBalancesReactNative,
+    },
   ]}
 />
 
 :::warning VirtualCurrencies does not update automatically when balance changes
 When a customer's balance is updated from your backend, the `VirtualCurrencies` object remains cached and is not automatically updated. To get the updated balance, you need to call `Purchases.shared.invalidateVirtualCurrenciesCache()` and fetch the `VirtualCurrencies` object again.
+
+We also recommend calling `invalidateVirtualCurrenciesCache()` after a purchase has completed successfully to ensure that the balances are up to date the next time you fetch them.
 :::
 
 You may directly access the cached virtual currencies using the `cachedVirtualCurrencies` property. This is helpful for rendering UI immediately, or for displaying virtual currencies when there is no network connection. Keep in mind that this value is cached and isn't guaranteed to be up to date.