WooCommerce Android

https://github.com/woocommerce/woocommerce-android
Admin
A Jetpack-powered mobile app for WooCommerce, enabling users to manage their stores on the go.
Tokens:6,900
Snippets:90
Trust Score:9.4
License:GPL-2.0
Update:1 year ago
Show doc for...
Tokens:
Raw
### Installing the WooCommerce Android App (Debug)

Source: https://github.com/woocommerce/woocommerce-android/blob/trunk/README.md

Installs the debug version of the WooCommerce Android application using Gradle. This command installs the .apk file on a connected Android device or emulator.

```bash
$ ./gradlew installVanillaDebug
```

--------------------------------

### Running Unit Tests for WooCommerce Android

Source: https://github.com/woocommerce/woocommerce-android/blob/trunk/README.md

Executes unit tests for the WooCommerce Android application using Gradle. This command assembles, installs, and runs the unit tests to verify the functionality of individual components.

```bash
$ ./gradlew :WooCommerce:testVanillaDebugUnitTest
```

--------------------------------

### Building the WooCommerce Android App (Debug)

Source: https://github.com/woocommerce/woocommerce-android/blob/trunk/README.md

Builds the debug version of the WooCommerce Android application using Gradle. This command assembles the debug .apk file, which can then be installed on a device or emulator.

```bash
$ ./gradlew assembleVanillaDebug
```

--------------------------------

### Running Android Tests for WooCommerce Android

Source: https://github.com/woocommerce/woocommerce-android/blob/trunk/README.md

Executes Android instrumentation tests for the WooCommerce Android application using Gradle. This command assembles, installs, and runs the Android tests on a connected device or emulator.

```bash
$ ./gradlew :WooCommerce:connectedVanillaDebugAndroidTest
```

--------------------------------

### Implementing a Regular Divider in XML

Source: https://github.com/woocommerce/woocommerce-android/blob/trunk/docs/theming-styling-best-practices.md

This snippet demonstrates how to implement a regular divider in XML using the `Woo.Divider` style. It includes margin configurations for start and end alignment.

```XML
<View
    android:id=“@+id/paymentInfo_total-paid_divider”
    style=“@style/Woo.Divider”
    android:layout_marginStart=“@dimen/major_100”
    android:layout_marginEnd=“@dimen/minor_00”/>
```

--------------------------------

### Cloning the WooCommerce Android Repository

Source: https://github.com/woocommerce/woocommerce-android/blob/trunk/README.md

Clones the WooCommerce Android repository from GitHub to a local directory and navigates into the project directory. This is the first step in setting up the project for development.

```bash
$ git clone https://github.com/woocommerce/woocommerce-android.git
$ cd woocommerce-android
```

--------------------------------

### Running Detekt for Kotlin Linting

Source: https://github.com/woocommerce/woocommerce-android/blob/trunk/docs/project-overview.md

This command executes Detekt, a static code analysis tool for Kotlin, to perform linting and code style checks on the WooCommerce Android project.

```gradle
./gradlew detektAll
```

--------------------------------

### Using placeholders in Kotlin

Source: https://github.com/woocommerce/woocommerce-android/blob/trunk/docs/localization.md

This snippet shows how to use placeholders in Kotlin code with `String.format`.  The placeholders in the string resource are replaced with the provided variables.

```kotlin
// Do
val label = String.format(
        context.getString(string.continue_terms_of_service_text),
        title, productName
)
```

--------------------------------

### Retrieving User Blogs via XML-RPC

Source: https://github.com/woocommerce/woocommerce-android/blob/trunk/libs/fluxc-processor/src/main/resources/xmlrpc-endpoints.txt

This XML-RPC method retrieves a list of blogs associated with a user on the WordPress site. It is useful for multi-site installations where a user may have access to multiple blogs.

```XML-RPC
wp.getUsersBlogs
```

--------------------------------

### Running Detekt via Gradle

Source: https://github.com/woocommerce/woocommerce-android/blob/trunk/docs/coding-style.md

This command executes Detekt, a static analysis tool, to identify potential code quality issues in the WooCommerce Android project. It generates an HTML report in the specified directory.

```Groovy
$ ./gradlew detektAll
```

--------------------------------

### Defining contentDescription string in XML

Source: https://github.com/woocommerce/woocommerce-android/blob/trunk/docs/localization.md

This snippet demonstrates how to name a string resource intended for use as a `contentDescription`. Adding `_content_description` to the end of the name helps identify its purpose.

```xml
<string name="product_image_content_description">Product image</string>
```

--------------------------------

### Correct ViewModel Injection in Composable (Kotlin)

Source: https://github.com/woocommerce/woocommerce-android/blob/trunk/docs/compose.md

This example demonstrates the correct way to inject the ViewModel as a parameter to the composable function. This facilitates reusability and makes testing easier.

```Kotlin
@Composable
fun MyComposable(viewModel : MyViewModel = getViewModel()) {
	...
}
```

--------------------------------

### Using placeholders in XML

Source: https://github.com/woocommerce/woocommerce-android/blob/trunk/docs/localization.md

This snippet demonstrates the use of placeholders in string resources. Placeholders provide context for translators and allow them to rearrange the sentence structure as needed for different languages.

```xml
<!-- Do -->
<string name="continue_terms_of_service_text">By continuing, you agree to our %1$sTerms of Service%2$s.</string>
```

--------------------------------

### Unit Test Naming Convention Example - Button Click Shows Message

Source: https://github.com/woocommerce/woocommerce-android/blob/trunk/CONVENTION.md

This unit test checks that after a specific number of button clicks (9 in this case), clicking the button again displays the appropriate message. It first simulates 9 button clicks, then simulates one more click, and finally asserts that the message label displays the expected message.

```Kotlin
fun `given the button has 9 clicks, when the button is clicked, then the appropriate message is shown`() {
        // GIVEN
        repeat(9) { presenter.onButtonClick() }

        // WHEN
        presenter.onButtonClick()

        // THEN
        assertThat(messageLabel.text).isEqualTo("Wow, 10 clicks")
    }
```

--------------------------------

### Unit Test Naming Convention Example - Button Click Updates Sum

Source: https://github.com/woocommerce/woocommerce-android/blob/trunk/CONVENTION.md

This unit test verifies that when a button is clicked, the sum label is updated correctly. It retrieves the current sum from the label, simulates a button click using the presenter, and then asserts that the label's text has been updated to reflect the incremented sum.

```Kotlin
fun `when the button is clicked, then the sum label is updated`() {
        val currentSum = sumLabel.text as Int

        // WHEN
        presenter.onButtonClick()

        // THEN
        assertThat(sumLabel.text).isEqualTo("${currentSum + 1}")
    }
```

--------------------------------

### Defining a non-meaningful string name in XML

Source: https://github.com/woocommerce/woocommerce-android/blob/trunk/docs/localization.md

This snippet shows an example of a non-meaningful string name.  It lacks context about where the string is used, making it harder for translators to understand its purpose.

```xml
<!-- Avoid -->
<string name="shipping_details">Shipping details</string>
```

--------------------------------

### Correct Composable Function with ColumnScope (Kotlin)

Source: https://github.com/woocommerce/woocommerce-android/blob/trunk/docs/compose.md

This example demonstrates the correct way to structure a composable function by scoping the content inside a ColumnScope. This ensures consistent behavior regardless of the parent composable.

```Kotlin
@Composable
fun ColumnScope.MyComposable() {
	Text("Hello")
	Text("Foo")
}
```

--------------------------------

### Handling Software Updates for Card Readers

Source: https://github.com/woocommerce/woocommerce-android/blob/trunk/docs/card-reader-module.md

The client app should observe `CardReaderManager.softwareUpdateAvailability` to check for available updates. If an update is available, `CardReaderManager.startAsyncSoftwareUpdate()` can be called to start the update process, with `CardReaderManager.softwareUpdateStatus` providing updates on the update's progress.

```kotlin
CardReaderManager.softwareUpdateAvailability
```

```kotlin
CardReaderManager.startAsyncSoftwareUpdate()
```

```kotlin
CardReaderManager.softwareUpdateStatus
```

--------------------------------

### Incorrect ViewModel Acquisition in Composable (Kotlin)

Source: https://github.com/woocommerce/woocommerce-android/blob/trunk/docs/compose.md

This example shows an anti-pattern where the ViewModel is acquired directly inside the composable function. This makes testing more difficult.

```Kotlin
@Composable
fun MyComposable() {
	val viewModel by viewModel<MyViewModel>()
	...
}
```

--------------------------------

### Correct Composable Function with Column (Kotlin)

Source: https://github.com/woocommerce/woocommerce-android/blob/trunk/docs/compose.md

This example demonstrates the correct way to structure a composable function by scoping the content inside a Column container. This ensures consistent behavior regardless of the parent composable.

```Kotlin
@Composable
fun MyComposable() {
	Column(...){ 
		Text("Hello")
		Text("Foo")
	}
}
```

--------------------------------

### Handling pluralization with separate strings in XML

Source: https://github.com/woocommerce/woocommerce-android/blob/trunk/docs/localization.md

This snippet demonstrates how to handle pluralization by creating separate string resources for singular and plural forms. This is a workaround since GlotPress doesn't support quantity strings.

```xml
<string name="product_downloadable_files_value_multiple">%1$d files</string>
<string name="product_downloadable_files_value_single">1 file</string>
```

--------------------------------

### Handling pluralization with separate strings in Kotlin

Source: https://github.com/woocommerce/woocommerce-android/blob/trunk/docs/localization.md

This snippet shows how to select the appropriate string resource (singular or plural) in Kotlin code based on a count.  It uses an `if` statement to determine which string to use and then formats it with the count.

```kotlin
val message = if (downloadableFileCount == 1) {
    context.getString(string.product_downloadable_files_value_single)
} else {
    String.format(
            context.getString(string.product_downloadable_files_value_multiple),
            downloadableFileCount
    )
}
```

--------------------------------

### Implementing a Title-Aligned Divider in XML

Source: https://github.com/woocommerce/woocommerce-android/blob/trunk/docs/theming-styling-best-practices.md

This snippet shows how to implement a title-aligned divider in XML using the `Woo.Divider.TitleAligned` style. This divider is specifically designed to align with titles.

```XML
<View style=“@style/Woo.Divider.TitleAligned”/>
```

--------------------------------

### Accessing string resource in Kotlin code

Source: https://github.com/woocommerce/woocommerce-android/blob/trunk/docs/localization.md

This snippet demonstrates how to access a string resource defined in `strings.xml` from Kotlin code using the `getString` method of the `Context` object. The `R.string.orderdetail_shipping_details` refers to the resource ID of the string.

```kotlin
val label = context.getString(R.string.orderdetail_shipping_details)
```

--------------------------------

### Defining a meaningful string name in XML

Source: https://github.com/woocommerce/woocommerce-android/blob/trunk/docs/localization.md

This snippet illustrates the recommended practice of using meaningful names for string resources in `strings.xml`.  The name should clearly indicate where the string is used in the application to provide context for translators.

```xml
<!-- Do -->
<string name="orderdetail_shipping_details">Shipping details</string>
```

--------------------------------

### Defining a translatable string in strings.xml

Source: https://github.com/woocommerce/woocommerce-android/blob/trunk/docs/localization.md

This snippet shows how to define a translatable string resource in the `strings.xml` file.  This is the standard way to add user-facing text to the app that needs to be localized. The `name` attribute is the unique identifier for the string.

```xml
<string name="orderdetail_shipping_details">Shipping details</string>
```

--------------------------------

### Avoiding string concatenation in Kotlin

Source: https://github.com/woocommerce/woocommerce-android/blob/trunk/docs/localization.md

This snippet shows how to avoid string concatenation in Kotlin. Concatenating strings can lead to translation issues, especially for languages with different grammatical structures.

```kotlin
// Don't
val label = context.getString(string.continue_terms_of_service_text_first_part) +
        " $title " + context.getString(string.continue_terms_of_service_text_second_part) + " $productName"
```

--------------------------------

### Avoiding string concatenation in XML

Source: https://github.com/woocommerce/woocommerce-android/blob/trunk/docs/localization.md

This snippet shows how to avoid string concatenation in XML. Concatenating strings can lead to translation issues, especially for languages with different grammatical structures.

```xml
<!-- Don't -->
<string name="continue_terms_of_service_text_first_part">By continuing, you agree to our</string>
<string name="continue_terms_of_service_text_second_part"> Terms of Service.</string>
```

--------------------------------

### Composable Function with Modifier Parameter (Kotlin)

Source: https://github.com/woocommerce/woocommerce-android/blob/trunk/docs/compose.md

This example demonstrates how to properly define a composable function that accepts a Modifier parameter. The Modifier is named 'modifier', appears as the first optional parameter, and is applied to the Column layout.

```Kotlin
@Composable
fun MyComposable(
    name: String,
    foo: String,
    modifier: Modifier = Modifier
) {
    Column(
        modifier = modifier
            .padding(start = 16.dp)
            .fillMaxWidth()
    ) {
        Text(name)
        Text(foo)
    }
}
```

--------------------------------

### Using string resource in layout XML

Source: https://github.com/woocommerce/woocommerce-android/blob/trunk/docs/localization.md

This snippet shows how to use a string resource in a layout XML file. The `android:text` attribute is set to `@string/orderdetail_shipping_details`, which references the string resource defined in `strings.xml`.

```xml
<TextView
    ...
    android:text="@string/orderdetail_shipping_details"
    ...
    />
```

--------------------------------

### Incorrect Composable Function (Kotlin)

Source: https://github.com/woocommerce/woocommerce-android/blob/trunk/docs/compose.md

This example shows an anti-pattern where a composable function emits content at its top level without scoping it inside a container. This can lead to unpredictable behavior depending on the parent composable.

```Kotlin
@Composable
fun MyComposable() {
	Text("Hello")
	Text("Foo")
}
```

--------------------------------

### Listing System Methods via XML-RPC

Source: https://github.com/woocommerce/woocommerce-android/blob/trunk/libs/fluxc-processor/src/main/resources/xmlrpc-endpoints.txt

This XML-RPC method lists all available XML-RPC methods on the WordPress site. It allows the Android app to discover the available functionalities.

```XML-RPC
system.listMethods
```

--------------------------------

### Initializing CardReaderModule in Android

Source: https://github.com/woocommerce/woocommerce-android/blob/trunk/docs/card-reader-module.md

The CardReaderModule needs to be initialized before use. This involves calling the `initialize(..)` method of the `CardReaderManager`. This method sets up the module for subsequent operations like discovering and connecting to card readers.

```kotlin
CardReaderManager.initialize(..)
```

--------------------------------

### Creating a New Post via XML-RPC

Source: https://github.com/woocommerce/woocommerce-android/blob/trunk/libs/fluxc-processor/src/main/resources/xmlrpc-endpoints.txt

This XML-RPC method creates a new post on the WordPress site. It allows the Android app to publish new content to the blog.

```XML-RPC
wp.newPost
```

--------------------------------

### Retrieving Media Library via XML-RPC

Source: https://github.com/woocommerce/woocommerce-android/blob/trunk/libs/fluxc-processor/src/main/resources/xmlrpc-endpoints.txt

This XML-RPC method retrieves the media library items from the WordPress site. It allows the Android app to access and display media files.

```XML-RPC
wp.getMediaLibrary
```

--------------------------------

### Initializing ComposeTestRule in Kotlin

Source: https://github.com/woocommerce/woocommerce-android/blob/trunk/docs/compose.md

This code snippet demonstrates how to initialize the `ComposeTestRule` in a Kotlin test class. The `ComposeTestRule` is essential for interacting with Compose UI elements during testing, enabling functionalities like finding elements, performing actions, and making assertions.

```kotlin
class MyComposeTest {

	@get:Rule
	val composeTestRule = createComposeRule()

	...
}
```

--------------------------------

### Retrieving WordPress Options via XML-RPC

Source: https://github.com/woocommerce/woocommerce-android/blob/trunk/libs/fluxc-processor/src/main/resources/xmlrpc-endpoints.txt

This XML-RPC method retrieves various options configured on the WordPress site. It allows the Android app to access settings and configurations.

```XML-RPC
wp.getOptions
```

--------------------------------

### Uploading a File via XML-RPC

Source: https://github.com/woocommerce/woocommerce-android/blob/trunk/libs/fluxc-processor/src/main/resources/xmlrpc-endpoints.txt

This XML-RPC method uploads a file to the WordPress media library. It allows the Android app to upload images, videos, and other files to the site.

```XML-RPC
wp.uploadFile
```

--------------------------------

### Device Type Detection using isTablet() Extension Function

Source: https://github.com/woocommerce/woocommerce-android/blob/trunk/docs/supporting-tablets.md

Utilize the isTablet() extension function available for both Fragment and Activity classes to determine if the application is running on a tablet. This function helps in applying different layouts or logic based on the device type.

```kotlin
// Example of using isTablet() extension function in a Fragment
import androidx.fragment.app.Fragment

fun Fragment.isTablet(): Boolean {
    return resources.getBoolean(R.bool.is_tablet)
}

// Usage:
if (isTablet()) {
    // Apply tablet-specific layout or logic
}
```

```kotlin
// Example of using isTablet() extension function in an Activity
import androidx.appcompat.app.AppCompatActivity

fun AppCompatActivity.isTablet(): Boolean {
    return resources.getBoolean(R.bool.is_tablet)
}

// Usage:
if (isTablet()) {
    // Apply tablet-specific layout or logic
}
```

--------------------------------

### Using waitUntil for Synchronization in Compose UI Tests

Source: https://github.com/woocommerce/woocommerce-android/blob/trunk/docs/compose.md

This code snippet demonstrates how to use `waitUntil` for synchronization in Compose UI tests. `waitUntil` is a recommended approach for waiting for background tasks to complete and update the UI, providing a more reliable alternative to `Thread.sleep()` or idling resources.

```kotlin
composeTestRule.waitUntil {
	composeTestRule
		.onAllNodesWithText("Welcome")
		.fetchSemanticsNodes().size == 1
}
```

--------------------------------

### Retrieving Media Item via XML-RPC

Source: https://github.com/woocommerce/woocommerce-android/blob/trunk/libs/fluxc-processor/src/main/resources/xmlrpc-endpoints.txt

This XML-RPC method retrieves a specific media item from the WordPress site based on its ID. It allows the Android app to fetch details about a particular media file.

```XML-RPC
wp.getMediaItem
```

--------------------------------

### Retrieving Posts via XML-RPC

Source: https://github.com/woocommerce/woocommerce-android/blob/trunk/libs/fluxc-processor/src/main/resources/xmlrpc-endpoints.txt

This XML-RPC method retrieves a list of posts from the WordPress site based on specified criteria. It allows the Android app to fetch multiple posts, potentially filtered by category, author, or date.

```XML-RPC
wp.getPosts
```

--------------------------------

### Discovering Card Readers using CardReaderManager

Source: https://github.com/woocommerce/woocommerce-android/blob/trunk/docs/card-reader-module.md

The `discoverReaders(..)` method of the `CardReaderManager` is used to initiate the discovery of nearby card readers. This process is mandatory before connecting to a card reader, regardless of previous connections.

```kotlin
CardReaderManager.discoverReaders(..)
```

--------------------------------

### Wrapping Feature Flags for Testing in Kotlin

Source: https://github.com/woocommerce/woocommerce-android/blob/trunk/docs/feature-flags.md

This Kotlin code shows how to create a wrapper class for a feature flag to facilitate testing.  The wrapper class allows the feature flag's state to be easily mocked during unit tests, decoupling the test from the actual FeatureFlag enum.

```Kotlin
class IsShippingLabelsEnabled @Inject constructor() {
    operator fun invoke(): Boolean = FeatureFlag.SHIPPING_LABELS_M4.isEnabled()
}
```

--------------------------------

### Connecting to a Discovered Card Reader

Source: https://github.com/woocommerce/woocommerce-android/blob/trunk/docs/card-reader-module.md

After a card reader is discovered, the `startConnectionToReader(..)` method is used to establish a connection. This method requires a location ID associated with the Stripe account. The `CardReader` object may contain a cached location ID.

```kotlin
CardReaderManager.startConnectionToReader(..)
```

--------------------------------

### Configuring Local FluxC Path in Gradle

Source: https://github.com/woocommerce/woocommerce-android/blob/trunk/docs/network-fluxc.md

This code snippet shows how to configure the local path to the FluxC library in the `local-builds.gradle` file for local development and testing. This allows developers to use local FluxC sources instead of a remote dependency.

```gradle
ext {
 localFluxCPath = "path_to_fluxc/WordPress-FluxC-Android"
}
```

--------------------------------

### Applying WooThemeWithBackground in Compose

Source: https://github.com/woocommerce/woocommerce-android/blob/trunk/docs/compose.md

This snippet shows how to use WooThemeWithBackground to support light/dark modes when the composable root function doesn't support contentColor. It's used in MoreMenuFragment.kt to ensure proper theming.

```Kotlin
setContent {
    WooThemeWithBackground {
        MoreMenu(viewModel)
    }
}
```

--------------------------------

### Tracking a Simple Analytics Event in Kotlin

Source: https://github.com/woocommerce/woocommerce-android/blob/trunk/docs/tracking-events.md

This code snippet demonstrates how to track a simple analytics event using the `AnalyticsTracker` in a Kotlin class. It shows the basic structure for triggering an event when a specific action occurs, such as refreshing data.

```Kotlin
class OrderDetailViewModel {
    fun onRefreshRequested() {
        AnalyticsTracker.track(Stat.ORDER_DETAIL_PULLED_TO_REFRESH)
    }
}
```

--------------------------------

### Retrieving Post Formats via XML-RPC

Source: https://github.com/woocommerce/woocommerce-android/blob/trunk/libs/fluxc-processor/src/main/resources/xmlrpc-endpoints.txt

This XML-RPC method retrieves the supported post formats on the WordPress site. It allows the Android app to determine the available post formats for creating or editing posts.

```XML-RPC
wp.getPostFormats
```

--------------------------------

### Applying WooTheme in Compose

Source: https://github.com/woocommerce/woocommerce-android/blob/trunk/docs/compose.md

This snippet demonstrates how to apply the default WooTheme to a composable function. It wraps the MoreMenu composable with the WooTheme to ensure consistent styling.

```Kotlin
WooTheme {
    MoreMenu(viewModel)
}
```

--------------------------------

### Creating a New Term via XML-RPC

Source: https://github.com/woocommerce/woocommerce-android/blob/trunk/libs/fluxc-processor/src/main/resources/xmlrpc-endpoints.txt

This XML-RPC method creates a new term (category, tag, etc.) on the WordPress site. It allows the Android app to add new taxonomy terms.

```XML-RPC
wp.newTerm
```

--------------------------------

### Setting hint for editable elements

Source: https://github.com/woocommerce/woocommerce-android/blob/trunk/docs/accessibility-guidelines.md

Use the `android:hint` XML attribute for static editable elements (`EditText`) and `setHint()` for dynamic elements to provide a description of the expected input, improving accessibility for screen reader users.

```xml
android:hint="Enter your text here"
```

--------------------------------

### Styling TextView for RTL Support in Android

Source: https://github.com/woocommerce/woocommerce-android/blob/trunk/docs/right-to-left-layout-guidelines.md

This XML snippet demonstrates how to style a TextView to properly support RTL layouts by setting gravity and textAlignment attributes. It ensures consistent text alignment across different locales.

```xml
<style name="Woo.TextView.Subtitle2">
    <item name="android:textAppearance">?attr/textAppearanceSubtitle2</item>
    <item name="android:textColor">@color/color_on_surface_medium</item>
    <item name="android:gravity">center_vertical|start</item>
    <item name="android:textAlignment">gravity</item>
</style>
```

--------------------------------

### Creating a New Comment via XML-RPC

Source: https://github.com/woocommerce/woocommerce-android/blob/trunk/libs/fluxc-processor/src/main/resources/xmlrpc-endpoints.txt

This XML-RPC method creates a new comment on a post on the WordPress site. It allows the Android app to submit comments to blog posts.

```XML-RPC
wp.newComment
```

--------------------------------

### Retrieving Post via XML-RPC

Source: https://github.com/woocommerce/woocommerce-android/blob/trunk/libs/fluxc-processor/src/main/resources/xmlrpc-endpoints.txt

This XML-RPC method retrieves a specific post from the WordPress site based on its ID. It allows the Android app to fetch the content and metadata of a particular post.

```XML-RPC
wp.getPost
```

--------------------------------

### Retrieving User Profile via XML-RPC

Source: https://github.com/woocommerce/woocommerce-android/blob/trunk/libs/fluxc-processor/src/main/resources/xmlrpc-endpoints.txt

This XML-RPC method retrieves the user profile information from the WordPress site. It allows the Android app to fetch details about the logged-in user.

```XML-RPC
wp.getProfile
```

--------------------------------

### Retrieving Terms via XML-RPC

Source: https://github.com/woocommerce/woocommerce-android/blob/trunk/libs/fluxc-processor/src/main/resources/xmlrpc-endpoints.txt

This XML-RPC method retrieves a list of terms (categories, tags, etc.) from the WordPress site. It allows the Android app to fetch multiple taxonomy terms, potentially filtered by taxonomy type.

```XML-RPC
wp.getTerms
```

--------------------------------

### Retrieving Comments via XML-RPC

Source: https://github.com/woocommerce/woocommerce-android/blob/trunk/libs/fluxc-processor/src/main/resources/xmlrpc-endpoints.txt

This XML-RPC method retrieves a list of comments from the WordPress site based on specified criteria. It allows the Android app to fetch multiple comments, potentially filtered by post or status.

```XML-RPC
wp.getComments
```

--------------------------------

### Grouping content in a focusable container

Source: https://github.com/woocommerce/woocommerce-android/blob/trunk/docs/accessibility-guidelines.md

Grouping a set of related elements in a focusable container (using `android:focusable="true"`) allows users to treat them as a single unit of information, improving navigation and understanding for users of assistive technologies.

```xml
android:focusable="true"
```

--------------------------------

### FragmentContainerView as NavHostFragment in XML

Source: https://github.com/woocommerce/woocommerce-android/blob/trunk/docs/supporting-tablets.md

Incorporate a new FragmentContainerView in your XML layout for screens requiring a two-pane layout. This view should also function as a NavHostFragment, containing either the detail or list pane of your screen. Assign a navigation graph to this NavHostFragment for proper navigation management.

```xml
<!-- Example of FragmentContainerView as NavHostFragment -->
<androidx.fragment.app.FragmentContainerView
    android:id="@+id/nav_host_fragment"
    android:layout_width="0dp"
    android:layout_height="match_parent"
    android:layout_weight="1"
    android:name="androidx.navigation.fragment.NavHostFragment"
    app:defaultNavHost="true"
    app:navGraph="@navigation/your_nav_graph" />
```

--------------------------------

### Retrieving a Term via XML-RPC

Source: https://github.com/woocommerce/woocommerce-android/blob/trunk/libs/fluxc-processor/src/main/resources/xmlrpc-endpoints.txt

This XML-RPC method retrieves a specific term (category, tag, etc.) from the WordPress site based on its ID. It allows the Android app to fetch details about a particular taxonomy term.

```XML-RPC
wp.getTerm
```

--------------------------------

### Deleting a Post via XML-RPC

Source: https://github.com/woocommerce/woocommerce-android/blob/trunk/libs/fluxc-processor/src/main/resources/xmlrpc-endpoints.txt

This XML-RPC method deletes a post from the WordPress site. It allows the Android app to remove content from the blog.

```XML-RPC
wp.deletePost
```

--------------------------------

### Currency Switching on Deposits Summary

Source: https://github.com/woocommerce/woocommerce-android/blob/trunk/CHANGELOG.md

WooPayments users can now seamlessly switch between currencies on the Deposits Summary view. This feature provides more flexibility for users who handle transactions in multiple currencies.

```text
WooPayments users can now seamlessly switch between currencies on the Deposits Summary view.
```

--------------------------------

### Using Wrapped Feature Flag in Kotlin

Source: https://github.com/woocommerce/woocommerce-android/blob/trunk/docs/feature-flags.md

This Kotlin code snippet demonstrates how to use the wrapper class `IsShippingLabelsEnabled` to check the status of a feature flag. This approach allows for easier mocking and testing of the feature flag logic.

```Kotlin
if (!isShippingLabelsEnabled()) {
    binding.expandIcon.isVisible = false
} else {
    binding.expandIcon.isVisible = true
}
```

--------------------------------

### Setting contentDescription to null for labeled buttons

Source: https://github.com/woocommerce/woocommerce-android/blob/trunk/docs/accessibility-guidelines.md

Setting `contentDescription` to null for buttons (`ImageButton`) with labels prevents redundant announcements by screen readers, as the label already provides sufficient context. Setting `importanceForAccessibility` to “no” makes them unfocusable in the accessibility mode.

```xml
android:contentDescription="null"
```

--------------------------------

### Mocking Feature Flag Wrapper in Kotlin Test

Source: https://github.com/woocommerce/woocommerce-android/blob/trunk/docs/feature-flags.md

This Kotlin code demonstrates how to mock the `IsShippingLabelsEnabled` wrapper class in a unit test using Mockito's `whenever` function. This allows you to control the return value of the feature flag check during testing.

```Kotlin
whenever(isShippingLabelsEnabled.invoke()).thenReturn(true)
```

--------------------------------

### Retrieving a Comment via XML-RPC

Source: https://github.com/woocommerce/woocommerce-android/blob/trunk/libs/fluxc-processor/src/main/resources/xmlrpc-endpoints.txt

This XML-RPC method retrieves a specific comment from the WordPress site based on its ID. It allows the Android app to fetch details about a particular comment.

```XML-RPC
wp.getComment
```

--------------------------------

### Constraining Width in ConstraintLayout for RTL Support

Source: https://github.com/woocommerce/woocommerce-android/blob/trunk/docs/right-to-left-layout-guidelines.md

This snippet shows how to use ConstraintLayout to handle RTL layouts by setting the view to wrap_content, constraining its width, and setting the horizontal bias. This ensures proper alignment and avoids UI disarrangement in RTL mode.

```ConstraintLayout
app:layout_constrainedWidth="true"
app:layout_constraintHorizontal_bias="0.0"
```

--------------------------------

### Tracking Analytics Event with Custom Properties in Kotlin

Source: https://github.com/woocommerce/woocommerce-android/blob/trunk/docs/tracking-events.md

This code snippet illustrates how to track an analytics event with custom properties using a map in Kotlin. It demonstrates how to include additional contextual information, such as error details, when tracking an event.

```Kotlin
class OrderDetailViewModel {
    fun onRefreshRequested() {
        AnalyticsTracker.track(
            PRODUCT_IMAGE_UPLOAD_FAILED,
                 mapOf(
                      AnalyticsTracker.KEY_ERROR_CONTEXT to this::class.java.simpleName,
                      AnalyticsTracker.KEY_ERROR_TYPE to event.error?.type?.toString(),
                      AnalyticsTracker.KEY_ERROR_DESC to event.error?.message
                 )
            )
    }
}
```

--------------------------------

### Editing a Post via XML-RPC

Source: https://github.com/woocommerce/woocommerce-android/blob/trunk/libs/fluxc-processor/src/main/resources/xmlrpc-endpoints.txt

This XML-RPC method edits an existing post on the WordPress site. It allows the Android app to modify the content and metadata of a post.

```XML-RPC
wp.editPost
```

--------------------------------

### Adding ComposeView to Fragment

Source: https://github.com/woocommerce/woocommerce-android/blob/trunk/docs/compose.md

This code snippet demonstrates how to add a ComposeView to a Fragment directly from the code, avoiding the need for separate layout XML files. It sets the ViewCompositionStrategy to DisposeOnViewTreeLifecycleDestroyed to prevent memory leaks. It also sets the content of the ComposeView with a WooThemeWithBackground composable.

```kotlin
override fun onCreateView(
        inflater: LayoutInflater,
        container: ViewGroup?,
        savedInstanceState: Bundle?
    ): View {
        return ComposeView(requireContext()).apply {
            // Dispose of the Composition when the view's LifecycleOwner
            // is destroyed
            setViewCompositionStrategy(DisposeOnViewTreeLifecycleDestroyed)
            setContent {
                WooThemeWithBackground {
                    // Compose code here.
                }
            }
        }
    }
```

--------------------------------

### Adding Images from Other Apps During Product Creation

Source: https://github.com/woocommerce/woocommerce-android/blob/trunk/CHANGELOG.md

Users can now seamlessly incorporate images from other apps when creating products. This feature simplifies the product creation process by allowing users to easily add images from various sources.

```text
Begin your product creation journey seamlessly by incorporating images from other apps.
```

--------------------------------

### Implementing Idle Function with Thread.sleep() in Kotlin

Source: https://github.com/woocommerce/woocommerce-android/blob/trunk/docs/compose.md

This code snippet shows an implementation of an idle function using `Thread.sleep()` in Kotlin. While this approach allows for waiting a specified amount of time, it is generally discouraged in UI testing due to its potential to slow down tests and introduce flakiness.

```kotlin
fun idleFor(milliseconds: Int) {
	try {
		Thread.sleep(milliseconds.toLong())
	} catch (ex: Exception) {
		// do nothing
	}
}
```

--------------------------------

### Setting labelFor attribute

Source: https://github.com/woocommerce/woocommerce-android/blob/trunk/docs/accessibility-guidelines.md

When a UI element is just a label for another element, set the `labelFor` attribute to associate the label with the element it describes, improving accessibility for screen reader users.

```xml
android:labelFor="@+id/target_element"
```

--------------------------------

### Virtual Products for Subscriptions

Source: https://github.com/woocommerce/woocommerce-android/blob/trunk/CHANGELOG.md

Users can now set subscription products as "virtual products". This feature allows users to designate subscription products that do not require shipping.

```text
You can also set subscription products as "virtual products".
```

--------------------------------

### Setting contentDescription for ImageButtons without text labels

Source: https://github.com/woocommerce/woocommerce-android/blob/trunk/docs/accessibility-guidelines.md

ImageButtons without text labels must have a valid `contentDescription` to provide context to users who rely on screen readers. The element type should be excluded from the `contentDescription`.

```xml
android:contentDescription="descriptive text"
```

--------------------------------

### Percentage-Based Custom Amounts

Source: https://github.com/woocommerce/woocommerce-android/blob/trunk/CHANGELOG.md

The revamped UI now introduces percentage-based custom amounts for added flexibility. This feature provides more options for setting custom amounts, enhancing the app's flexibility.

```text
Our revamped UI now introduces percentage-based custom amounts for added flexibility.
```

--------------------------------

### Checking Feature Flag Status in Kotlin

Source: https://github.com/woocommerce/woocommerce-android/blob/trunk/docs/feature-flags.md

This Kotlin code snippet demonstrates how to check the status of a feature flag and conditionally enable or disable UI elements based on its state. It uses the isEnabled() method of the FeatureFlag enum to determine whether to show or hide the expandIcon.

```Kotlin
if (!FeatureFlag.SHIPPING_LABELS_M4.isEnabled()) {
    binding.expandIcon.isVisible = false
} else {
    binding.expandIcon.isVisible = true
}
```

--------------------------------

### Setting State Description for Accessibility

Source: https://github.com/woocommerce/woocommerce-android/blob/trunk/docs/compose.md

This code snippet demonstrates how to add state descriptions to inform accessibility services if an item is in a certain state (e.g., selected or unselected). It uses Modifier.semantics to set the stateDescription based on the item's selected state.

```kotlin
val semanticsModifier =
	Modifier.semantics(mergeDescendants = true) {
		stateDescription = if (item.selected) {
			selectedDescription
		} else {
			unselectedDescription
		}
	}
```

--------------------------------

### Barcode Scanning for Inventory Updates

Source: https://github.com/woocommerce/woocommerce-android/blob/trunk/CHANGELOG.md

This update allows users to quickly update inventory by scanning barcodes directly from the Products page. This feature streamlines the inventory management process, making it more efficient.

```text
Enjoy swift inventory updates by effortlessly scanning barcodes directly from the Products page
```

--------------------------------

### Editing a Term via XML-RPC

Source: https://github.com/woocommerce/woocommerce-android/blob/trunk/libs/fluxc-processor/src/main/resources/xmlrpc-endpoints.txt

This XML-RPC method edits an existing term (category, tag, etc.) on the WordPress site. It allows the Android app to modify the details of a taxonomy term.

```XML-RPC
wp.editTerm
```

--------------------------------

### Disconnecting from Readers and Clearing Integration

Source: https://github.com/woocommerce/woocommerce-android/blob/trunk/docs/card-reader-module.md

To switch accounts or reset the Stripe Terminal SDK integration, first disconnect from connected readers using the `disconnect()` method. After the disconnection is complete, call the `clear()` method to reset the integration, clear caches, and prepare the Stripe Terminal to fetch a new connection token.

```kotlin
disconnect()
```

```kotlin
clear()
```

--------------------------------

### Editing a Comment via XML-RPC

Source: https://github.com/woocommerce/woocommerce-android/blob/trunk/libs/fluxc-processor/src/main/resources/xmlrpc-endpoints.txt

This XML-RPC method edits an existing comment on the WordPress site. It allows the Android app to modify the content and metadata of a comment.

```XML-RPC
wp.editComment
```

--------------------------------

### Setting importantForAccessibility to no

Source: https://github.com/woocommerce/woocommerce-android/blob/trunk/docs/accessibility-guidelines.md

Setting `importantForAccessibility` to "no" on illustrative images (`ImageView`) makes them unfocusable in accessibility mode, preventing screen readers from announcing them and reducing noise for users.

```xml
android:importantForAccessibility="no"
```

--------------------------------

### Tax for Custom Amounts and One-Time Shipping for Subscriptions

Source: https://github.com/woocommerce/woocommerce-android/blob/trunk/CHANGELOG.md

The latest update allows users to charge tax for custom amounts and set one-time shipping for subscription products. These features provide more control over pricing and shipping options.

```text
Our latest update allows you to charge tax for custom amounts and set one-time shipping for subscription products.
```

--------------------------------

### Defining Feature Flags using Enum in Kotlin

Source: https://github.com/woocommerce/woocommerce-android/blob/trunk/docs/feature-flags.md

This Kotlin enum defines feature flags for the WooCommerce Android app. The isEnabled() method determines if a feature is enabled based on the build configuration (debug, beta, testing) or other conditions like the availability of WooCommerce Payments.

```Kotlin
enum class FeatureFlag {
    SHIPPING_LABELS_M4,
    DB_DOWNGRADE,
    ORDER_CREATION,
    CARD_READER;

    /// Returns a boolean indicating if the feature is enabled
    fun isEnabled(context: Context? = null): Boolean {
        return when (this) {
            SHIPPING_LABELS_M4 -> PackageUtils.isDebugBuild() || PackageUtils.isTesting()
            DB_DOWNGRADE -> {
                PackageUtils.isDebugBuild() || context != null && PackageUtils.isBetaBuild(context)
            }
            ORDER_CREATION -> PackageUtils.isDebugBuild() || PackageUtils.isTesting()
            CARD_READER -> CardPresentEligibleFeatureChecker.isCardPresentEligible
        }
    }
}
```

--------------------------------

### Deleting a Term via XML-RPC

Source: https://github.com/woocommerce/woocommerce-android/blob/trunk/libs/fluxc-processor/src/main/resources/xmlrpc-endpoints.txt

This XML-RPC method deletes a term (category, tag, etc.) from the WordPress site. It allows the Android app to remove taxonomy terms.

```XML-RPC
wp.deleteTerm
```

--------------------------------

### AI-Generated Thank-You Notes

Source: https://github.com/woocommerce/woocommerce-android/blob/trunk/CHANGELOG.md

An AI feature has been added that generates a thank-you note on the completed order's details screen. This feature enhances customer engagement by providing personalized thank-you notes.

```text
Plus, we've added an AI feature that generates a thank-you note on the completed order's details screen.
```

--------------------------------

### Displaying California Consumer Privacy Act (CCPA) Notice

Source: https://github.com/woocommerce/woocommerce-android/blob/trunk/fastlane/metadata/android/ar/full_description.txt

This snippet shows the URL for displaying the California Consumer Privacy Act (CCPA) notice to users. It is a requirement for businesses that collect personal information from California residents.

```URL
https://automattic.com/privacy/#california-consumer-privacy-act-ccpa
```

--------------------------------

### Deleting a Comment via XML-RPC

Source: https://github.com/woocommerce/woocommerce-android/blob/trunk/libs/fluxc-processor/src/main/resources/xmlrpc-endpoints.txt

This XML-RPC method deletes a comment from the WordPress site. It allows the Android app to remove comments from blog posts.

```XML-RPC
wp.deleteComment
```
Tokens:
Raw