engage-sdk-integration

Generate Play Engage SDK integration boilerplate and entity mappings for Android apps.

174|8|Updated Jan 9, 2024
One-click install
npx skills add https://github.com/klxiaoniu/QQVersionList --skill engage-sdk-integration-klxiaoniu
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: engage-sdk-integration
Source: https://github.com/klxiaoniu/QQVersionList/tree/main/.agents/skills/engage-sdk-integration
Command: npx skills add https://github.com/klxiaoniu/QQVersionList --skill engage-sdk-integration-klxiaoniu

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This skill helps developers integrate the Play Engage SDK into an Android app by guiding them through the required structure, entity mappings, publishing request construction, and receiver registration so that Engage content publishing works correctly.

Core Features & Use Cases

  • Vertical + cluster setup: Identify the correct Engage client, entities, cluster types, and publish methods for the app’s vertical and target publishing scenario.
  • Deterministic boilerplate generation: Generate the required integration classes (constants, item-to-entity converter, request factory, WorkManager worker, publisher orchestrator, and broadcast receiver) following the Engage patterns.
  • Entity mapping & data sourcing: Map local app models to the required Engage entities and wire the worker to publish real data from the app’s storage/repository layer.
  • Android integration updates: Provide guidance for build.gradle and AndroidManifest.xml, including the mandatory static and dynamic BroadcastReceiver registration.
  • Debugging workflow: Provide a resolution order for Gradle sync/build and common import/compilation issues, with recommendations to iterate until the project builds successfully.

Quick Start

Use the engage-sdk-integration skill to generate an end-to-end Play Engage SDK integration for your Android app by following the vertical schema and implementing both static and dynamic EngageBroadcastReceiver registrations.

Frequently Asked Questions about engage-sdk-integration

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I integrate the Play Engage SDK into my Android app?

To integrate the Play Engage SDK, you need to generate boilerplate classes for your vertical, map app models to Engage entities, wire WorkManager for publishing, and register both static and dynamic BroadcastReceivers in your Manifest.

What is the correct way to map local data to Play Engage entities?

Mapping local data to Play Engage entities involves creating an item-to-entity converter that aligns your app models with the required vertical schemas, ensuring the WorkManager worker publishes real data from your repository layer.

How does WorkManager work with Play Engage SDK publishing?

WorkManager orchestrates Play Engage SDK publishing by utilizing an EngageWorker and EngagePublisher to construct publish requests and manage the data sourcing workflow from your app's storage.

Do I need a static and dynamic BroadcastReceiver for Play Engage SDK integration?

Yes, Play Engage SDK integration requires both static and dynamic BroadcastReceiver registrations in your AndroidManifest.xml and at runtime to satisfy Engage publishing and debugging requirements.

Why does my Gradle build fail when adding the Play Engage SDK?

Gradle build failures during Play Engage SDK integration usually stem from incorrect imports or compilation issues; you should follow a resolution order to iterate through Gradle sync and build errors until successful.

Can I use Kotlin to set up Play Engage SDK clusters and publish requests?

Yes, you can use Kotlin to set up Play Engage SDK clusters by identifying the correct Engage client, entities, and publish methods for your target vertical, and generating the required request factory code.