← Back to Docs
  • index.html
  • Clayground
  • Clayground.Ios
  • ClayIos
  • Clayground 2025.2

    • Contents

    ClayIos QML Type

    Provides iOS-specific functionality for Clayground applications. More...

    Import Statement: import Clayground.Ios

    Methods

    Detailed Description

    ClayIos is a singleton that exposes iOS platform features to QML. Currently it provides access to the App Store review request API.

    On non-iOS platforms, the methods log warnings but don't crash.

    Example usage:

    import Clayground.Ios

Button {
    text: "Rate this app"
    onClicked: ClayIos.requestReview()
}

    Note: For a complete review prompt system with user engagement tracking, see AppReviewController.

    See also AppReviewController.

    Method Documentation

    void requestReview()

    Requests an App Store review from the user.

    On iOS, this triggers the native SKStoreReviewController to show a review prompt. The system may choose not to show the prompt based on Apple's guidelines (limited to 3 prompts per year).

    On non-iOS platforms, this method logs a warning.