forcedotcom/sf-skills

mobile-platform-native-capabilities-integrate

Build a Salesforce LWC that uses native mobile device capabilities — barcode scanner, biometrics, location, NFC, calendar, contacts, document scanner, geofencing, AR space capture, app review, and payments.

ソースを見る

使い方

  1. インストールコマンドをコピーし、自分の環境へ導入する前にソースを確認します。
  2. 必要なツール、認証情報、対応環境を原文で確認します。
  3. 入力と成果物を指定し、出力を資料と照合します。
npx skills add https://github.com/forcedotcom/sf-skills --skill mobile-platform-native-capabilities-integrate

開始前の確認

  • 導入にはモデル契約、API枠、ファイルへのアクセス許可は含まれません。
  • スター数や導入数は活動の指標であり、独立した品質・安全性試験ではありません。
リポジトリの原文

見出し、例、コード、表、リンク、参照画像を含む原文を表示しています。

Using Mobile Native Capabilities

The lightning/mobileCapabilities module exposes a set of factory functions that return service objects for native device features (barcode scanning, biometrics, location, etc.). Each service extends a common BaseCapability with an isAvailable() method, so an LWC can degrade gracefully on surfaces where the capability is not present (desktop, mobile web).

This skill routes an agent through (1) picking the right capability, (2) loading the authoritative type definitions, and (3) wiring the service into an LWC with the correct availability gating, error handling, and deprecation-aware API choice.

When to Use This Skill

  • User asks for an LWC that uses a device capability listed in the index

below.

  • User mentions lightning/mobileCapabilities, "mobile capability", or

"Nimbus" by name.

  • User wants to know which mobile native APIs are available, or which one

fits their feature.

Do NOT use this skill for:

  • Mobile-offline review of an LWC (lwc:if, inline GraphQL, Komaci-priming

violations) — use mobile-platform-offline-validate.

  • Choosing or styling generic Lightning Base Components / SLDS blueprints —

use design-systems-slds-apply.

Prerequisites

  • Knowledge that the LWC will run inside a supported mobile container

(Salesforce Mobile App, Field Service Mobile App). These capabilities are unavailable on desktop and mobile web; gate every call behind isAvailable().

  • Familiarity with the lightning/mobileCapabilities module declaration

(see mobile-capabilities).

Capability Index

CapabilityReferenceOne-line use
App ReviewApp ReviewPrompt the user for a native in-app review.
AR Space CaptureAR Space CaptureCapture a 3D scan of a physical space using AR.
Barcode ScannerBarcode ScannerRead QR / UPC / EAN / Code-128 / etc. from the camera.
BiometricsBiometricsAuthenticate via Face ID / fingerprint.
CalendarCalendarRead or create events on the device calendar.
ContactsContactsRead or create entries in the device address book.
Document ScannerDocument ScannerScan paper documents using the camera with edge detection.
GeofencingGeofencingTrigger logic when the device crosses a geographic boundary.
LocationLocationRead GPS coordinates and watch for updates.
NFCNFCRead or write NFC tags.
PaymentsPaymentsTake an Apple Pay / Google Pay payment.

Workflow

Step 1 — Identify the capability

Map the user's feature ask to one row of the capability index. If the ask spans multiple capabilities (e.g. "scan a barcode and store it on a contact"), plan for each capability separately — there is one factory function per capability.

Step 2 — Load the shared and capability-specific references

Read these two shared references once per session — they apply to every capability and are not duplicated in the per-capability files:

with isAvailable() that every service extends.

lightning/mobileCapabilities module declaration showing every re-exported service.

Then open the capability's reference file from the table above. Each per-capability reference contains the service-specific TypeScript API (factory function, service interface, options types, result types, error types) and assumes the two shared references above are already in context.

Do not infer the API from memory — read it. The services evolve and some methods are explicitly @deprecated in favor of newer alternatives.

Step 3 — Wire the service into the LWC

For each capability:

  1. Import the factory from lightning/mobileCapabilities:
js
   import { getBarcodeScanner } from 'lightning/mobileCapabilities';
  1. Get an instance: const scanner = getBarcodeScanner();
  2. Gate the call behind isAvailable():
js
   if (!scanner.isAvailable()) {
     // graceful fallback or user message
     return;
   }
  1. Call the non-deprecated entry point. Several services keep older

methods marked @deprecated alongside the recommended one — always prefer the recommended method in the reference.

  1. Wrap the promise in try/catch and handle the typed failure codes the

service exposes (e.g. BarcodeScannerFailureCode, LocationServiceFailureCode). User-cancelled vs. permission-denied vs. service-unavailable are distinct UX states.

Step 4 — Surface failure modes to the user

Each service defines its own failure-code enum. Translate codes into user-actionable messages: a USER_DENIED_PERMISSION should ask the user to grant permission; a USER_DISABLED_PERMISSION must direct them to the OS settings; a SERVICE_NOT_ENABLED should be a developer-visible error, not shown to the user.

Step 5 — Stay inside the supported surface

Mobile capabilities are available only when the LWC runs inside a supported Salesforce mobile app. If the same component is rendered on desktop or mobile web, the factory will still return an object but isAvailable() will return false. Never assume availability — gate every call.

Examples

Example — "Scan a barcode and write it into a field"

  1. Map to: Barcode Scanner.
  2. Read Barcode Scanner.
  3. Use scan(options) (not the deprecated beginCapture / resumeCapture

/ endCapture triple).

  1. In options, set the barcodeTypes to the symbologies needed (default is

all supported types) and enableMultiScan: false for a single read.

  1. On resolve, write result[0].value to the bound field. On reject,

inspect error.code against BarcodeScannerFailureCode.

Example — "Take an Apple Pay payment for an order total"

  1. Map to: Payments.
  2. Read Payments.
  3. Gate on isAvailable().
  4. Build the payment request object per the reference.
  5. On resolve, surface the transaction id to the calling flow. On reject,

handle user-cancelled and payment-failed paths separately.

Verification Checklist

  • [ ] Every capability call is preceded by isAvailable().
  • [ ] The non-deprecated entry point is used (no beginCapture /

resumeCapture / endCapture for barcode, etc.).

  • [ ] Each rejection path is mapped to the typed failure code enum.
  • [ ] Imports come from lightning/mobileCapabilities, not from a private

path.

  • [ ] No assumption that the capability runs on desktop or mobile web.

Troubleshooting

  • `isAvailable()` returns `false` on a real device — the device is

running an unsupported app surface (not Salesforce Mobile or Field Service Mobile), or the service is gated by an org-level setting. The fix is org configuration, not code.

  • TypeScript can't find the import — confirm the LWC has access to

lightning/mobileCapabilities. The module is declared globally inside Salesforce mobile containers; outside that, the types must be installed separately.

  • Deprecated barcode methods still work — yes, but new code must use

scan() and dismiss(). Refactor any sample code the agent received before returning it.

  • Multiple capabilities in one component — get separate instances per

capability (they are independent service objects); do not try to share state between them.

タスクに関連する項目

同じリポジトリから

関連する Skills

すべての Skills
forcedotcom
コミュニティ

design-systems-slds-apply

Apply SLDS-compliant UI using the correct blueprints, styling hooks, utility classes, and icons. Use when building any UI that needs SLDS, choosing between Lightning Base Components and SLDS Blueprints, applying styling hooks for theming, using utility classes for layout and spacing, or selecting icons. Triggers include \"build a modal\", \"create a form\", \"data table\", \"SLDS styling\", \"style with hooks\", \"add an icon\".

1時間の導入数
1
GitHub Stars
1172
更新日
11月13日
forcedotcom
コミュニティ

dx-code-analyzer-run

Run Salesforce Code Analyzer to scan code for security, performance, best practice, and code style violations. Supports all engines (PMD, ESLint, CPD, RetireJS, Flow, SFGE, ApexGuru), targets (files, folders, git diff), categories, and severities. Also handles post-scan exploration: filtering results by engine/severity/category/file, and explaining what rules mean. TRIGGER when: user says 'scan my code', 'check security issues', 'run PMD/ESLint', 'find duplicates', 'analyze Flows', 'check vulner

1時間の導入数
1
GitHub Stars
1172
更新日
11月13日
forcedotcom
コミュニティ

experience-lwc-accessibility-jest-run

Use ALWAYS when running Sa11y accessibility Jest tests for an LWC — locally before pushing, producing the command(s), running one file vs a suite, selecting tests by naming convention, saving Sa11y-rendered HTML, or reproducing a Sa11y/A11yBug failure. Covers core (Bazel; bazel test // : ) and standalone npx jest (.accessibility.test.js, @sa11y/jest). REQUIRED for a run-plan.md, a failing a11y test's exit code, or SA11Y/A11yBug/core-Bazel test paths. DO NOT TRIGGER for functional Jest tests, a11

1時間の導入数
1
GitHub Stars
1172
更新日
11月13日
forcedotcom
コミュニティ

experience-lwc-generate

Lightning Web Components with PICKLES methodology and 165-point scoring. Use this skill when the user creates or edits LWC components, builds wire service patterns, or writes Jest tests for LWC. TRIGGER when: user creates/edits LWC components, touches lwc//.js, .html, .css, .js-meta.xml files, or asks about wire service, SLDS, or Jest LWC tests. DO NOT TRIGGER when: Apex classes (use platform-apex-generate), Aura components, or Visualforce.

1時間の導入数
1
GitHub Stars
1172
更新日
11月13日