Xaman Developer Docs
search
⌘Ctrlk
Developer ConsoleAPI Endpoints
Xaman Developer Docs
  • Build on Xaman
  • Concepts
    • Getting started
    • 🔐Authorization & Credentials
    • Payloads (sign requests)
    • Special Transaction Types
    • Limitations
    • Implementation checklist
  • Simple link / QR
    • Payment Request Link
    • TrustSet Link/QR
  • Environments
    • 🌎Browser ("Web3")
    • 📱xApps ("dApps")
    • 📂Backend (SDK / API)
    • 🎛️Native Apps
    • 🙇Identity (OAuth2, OpenID)
  • JS/TS SDK
    • Xaman SDK (Intro)
    • Examples / User stories
    • 📦SDK (syntax)
      • Xumm.ping()
      • Xumm.on(event, fn)
      • Xumm.off(event, fn)
      • Xumm.helpers { … }
      • Xumm.user { … }
      • Xumm.environment { … }
      • Xumm.payload { … }
      • Xumm.xapp { … }
      • Xumm.userstore { … }
      • Xumm.backendstore { … }
      • Xumm.push { … }
      • Xumm.runtime { … }
      • Xumm.authorize()
      • Xumm.logout()
gitbookPowered by GitBook
block-quoteOn this pagechevron-down
githubEdit
  1. JS/TS SDK

📦SDK (syntax)

Developers can use the Xumm SDK to easily interact with the Xumm platform. This section contains the technical documentation for the Javascript/TypeScript API (objects, methods, arguments).

Xumm.ping()chevron-rightXumm.on(event, fn)chevron-rightXumm.off(event, fn)chevron-rightXumm.helpers { … }chevron-rightXumm.user { … }chevron-rightXumm.environment { … }chevron-rightXumm.payload { … }chevron-rightXumm.xapp { … }chevron-rightXumm.userstore { … }chevron-rightXumm.backendstore { … }chevron-rightXumm.push { … }chevron-rightXumm.runtime { … }chevron-rightXumm.authorize()chevron-rightXumm.logout()chevron-right
PreviousSimple Sign Requestchevron-leftNextXumm.ping()chevron-right

Last updated 2 years ago

Was this helpful?

Was this helpful?