capacitor-plugin-walkme-sdk

capacitor-plugin-walkme-sdk

A Simple SDK that allows anyone to create and manage in-app content without coding and without deployment, to maximize in-app user engagement.

Install

npm install capacitor-plugin-walkme-sdk
npx cap sync

API

• start(...)
• restart()
• stop()
• setFlag(...)
• setUserID(...)
• setUserAttribute(...)
• setUserAttributes(...)
• setPrivateUserAttribute(...)
• setPrivateUserAttributes(...)
• cleatPrivateUserAttributes()
• sendTrackedEvent(...)
• setScreenID(...)
• setLanguage(...)
• dismissCampaign()
• triggerCampaign(...)
• triggerCampaignWithDeepLink(...)
• Interfaces

start(...)

start(options: WMKSPair) => Promise<{ value: string; }>

Starts WalkMe SDK.

Param	Type
options	WMKSPair

Returns: Promise<{ value: string; }>

---

restart()

restart() => Promise<{ value: string; }>

Restarts WalkMe SDK.

This method can be called only after WalkMe start was called first. WalkMe SDK restart is allowed if current session has been running for at least 30 seconds.

Returns: Promise<{ value: string; }>

---

stop()

stop() => Promise<{ value: string; }>

Stop WalkMe SDK.

This method can be called only after WalkMe start was called first.

Returns: Promise<{ value: string; }>

---

setFlag(...)

setFlag(flag: WMFlag) => Promise<void>

Utility function for support.

Param	Type	Description
flag	WMFlag	Will be given by WalkMe support team when needed

---

setUserID(...)

setUserID(userID: WMUserID) => Promise<{ value: string; }>

Sets user id

Param	Type	Description
userID	WMUserID	the user ID as a string

Returns: Promise<{ value: string; }>

---

setUserAttribute(...)

setUserAttribute(options: WMKVPair) => Promise<{ value: string; }>

Sets a user attribute

Param	Type
options	WMKVPair

Returns: Promise<{ value: string; }>

---

setUserAttributes(...)

setUserAttributes(options: WMAttributes) => Promise<{ value: string; }>

Sets multiple user attributes

Param	Type
options	WMAttributes

Returns: Promise<{ value: string; }>

---

setPrivateUserAttribute(...)

setPrivateUserAttribute(options: WMKVPair) => Promise<{ value: string; }>

Sets a user attribute

Param	Type
options	WMKVPair

Returns: Promise<{ value: string; }>

---

setPrivateUserAttributes(...)

setPrivateUserAttributes(options: WMAttributes) => Promise<{ value: string; }>

Sets multiple user attributes

Param	Type
options	WMAttributes

Returns: Promise<{ value: string; }>

---

cleatPrivateUserAttributes()

cleatPrivateUserAttributes() => Promise<void>

clears the private user attributes

---

sendTrackedEvent(...)

sendTrackedEvent(options: WMTrackedEvent) => Promise<{ value: string; }>

Sets multiple user attributes

Param	Type
options	WMTrackedEvent

Returns: Promise<{ value: string; }>

---

setScreenID(...)

setScreenID(screenID: WMScreenID) => Promise<void>

Set ID for a specific screen. When used, this should be called everytime the screen shows

Param	Type	Description
screenID	WMScreenID	the ID to set for a specific screen

---

setLanguage(...)

setLanguage(language: WMLanguage) => Promise<{ value: string; }>

Set the language for your campaigns. When used, the language param you pass should match the name of one of the languages you’ve set up in the console.

Param	Type	Description
language	WMLanguage	the language for which you want the SDK to display your campaigns

Returns: Promise<{ value: string; }>

---

dismissCampaign()

dismissCampaign() => Promise<void>

Dismiss currently presented campaign, in case nothing is presented this API does nothing. Exception for launcher campaigns which are not affected by this API.

---

triggerCampaign(...)

triggerCampaign(trigger: WMTrigger) => Promise<{ value: string; }>

Launches a campaign by trigger key Once invoked, the method will show the campaign WITHOUT any of its segments (if defined)

Param	Type
trigger	WMTrigger

Returns: Promise<{ value: string; }>

---

triggerCampaignWithDeepLink(...)

triggerCampaignWithDeepLink(options: WMTriggerFromDeepLink) => Promise<{ value: string; }>

Launches a campaign by trigger key Once invoked, the method will show the campaign WITHOUT any of its segments (if defined)

Param	Type
options	WMTriggerFromDeepLink

Returns: Promise<{ value: string; }>

---

Interfaces

WMKSPair

Prop	Type
key	string
secret	string

WMFlag

Prop	Type
flag	number

WMUserID

Prop	Type
userID	string

WMKVPair

Prop	Type
key	string
value	string | number | boolean

WMAttributes

Prop	Type
attributes	any

WMTrackedEvent

Prop	Type
name	string
properties	any

WMScreenID

Prop	Type
screenID	string

WMLanguage

Prop	Type
language	string

WMTrigger

Prop	Type
triggerKey	string

WMTriggerFromDeepLink

Prop	Type
triggerKey	string
deeplink	string