Xaman Developer Docs
search
Ctrlk
Developer ConsoleAPI Endpoints
  • Build on Xaman
  • Concepts
    • Getting startedchevron-right
    • πŸ”Authorization & Credentials
    • Payloads (sign requests)chevron-right
    • Special Transaction Typeschevron-right
    • Limitationschevron-right
    • Implementation checklistchevron-right
  • Simple link / QR
    • Payment Request Link
    • TrustSet Link/QR
  • Environments
    • 🌎Browser ("Web3")chevron-right
    • πŸ“±xApps ("dApps")chevron-right
    • πŸ“‚Backend (SDK / API)chevron-right
    • πŸŽ›οΈNative Apps
    • πŸ™‡Identity (OAuth2, OpenID)chevron-right
  • JS/TS SDK
    • Xaman SDK (Intro)
    • Examples / User storieschevron-right
    • πŸ“¦SDK (syntax)chevron-right
      • Xumm.ping()
      • Xumm.on(event, fn)
      • Xumm.off(event, fn)
      • Xumm.helpers { … }chevron-right
      • Xumm.user { … }
      • Xumm.environment { … }
      • Xumm.payload { … }chevron-right
      • Xumm.xapp { … }chevron-right
      • Xumm.userstore { … }chevron-right
      • Xumm.backendstore { … }chevron-right
      • Xumm.push { … }chevron-right
      • 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