pushwoosh-capacitor-plugin

pushwoosh-capacitor-plugin

Pushwoosh plugin for Capacitor

Install

npm install pushwoosh-capacitor-plugin
npx cap sync

API

• onDeviceReady(...)
• registerDevice()
• unregisterDevice()
• additionalAuthorizationOptions(...)
• setTags(...)
• getTags()
• getPushToken()
• getPushwooshHWID()
• getRemoteNotificationStatus()
• setApplicationIconBadgeNumber(...)
• getApplicationIconBadgeNumber()
• addToApplicationIconBadgeNumber(...)
• getLaunchNotification()
• clearLaunchNotification()
• setUserId(...)
• setLanguage(...)
• postEvent(...)
• setMultiNotificationMode()
• setSingleNotificationMode()
• pushReceivedCallback(...)
• pushOpenedCallback(...)
• presentInboxUI(...)
• showGDPRConsentUI()
• showGDPRDeletionUI()
• setCommunicationEnabled(...)
• removeAllDeviceData()
• isCommunicationEnabled(...)
• isDeviceDataRemoved(...)
• isAvailableGDPR(...)
• Interfaces
• Type Aliases

onDeviceReady(...)

onDeviceReady(config: PushwooshConfig) => void

Param	Type
config	PushwooshConfig

registerDevice()

registerDevice() => Promise<{ pushToken: string; }>

Returns: Promise<{ pushToken: string; }>

unregisterDevice()

unregisterDevice() => Promise<void>

additionalAuthorizationOptions(...)

additionalAuthorizationOptions(options: AuthOptions) => void

Param	Type
options	AuthOptions

setTags(...)

setTags(config: PushwooshTags) => Promise<void>

Param	Type
config	PushwooshTags

getTags()

getTags() => Promise<{ tags: PushwooshTags; }>

Returns: Promise<{ tags: PushwooshTags; }>

getPushToken()

getPushToken() => { value: string | null; }

Returns: { value: string | null; }

getPushwooshHWID()

getPushwooshHWID() => { value: string | null; }

Returns: { value: string | null; }

getRemoteNotificationStatus()

getRemoteNotificationStatus() => Promise<{ status: RemoteNotificationStatus; }>

Returns: Promise<{ status: RemoteNotificationStatus; }>

setApplicationIconBadgeNumber(...)

setApplicationIconBadgeNumber(badge: number) => void

Param	Type
badge	number

getApplicationIconBadgeNumber()

getApplicationIconBadgeNumber() => Promise<{ badge: number; }>

Returns: Promise<{ badge: number; }>

addToApplicationIconBadgeNumber(...)

addToApplicationIconBadgeNumber(badge: number) => void

Param	Type
badge	number

getLaunchNotification()

getLaunchNotification() => { notification: string; }

Returns: { notification: string; }

clearLaunchNotification()

clearLaunchNotification() => void

setUserId(...)

setUserId(userId: string) => void

Param	Type
userId	string

setLanguage(...)

setLanguage(language: string) => void

Param	Type
language	string

postEvent(...)

postEvent(event: string, attributes?: Record<string, string> | undefined) => void

Param	Type
event	string
attributes	Record<string, string>

setMultiNotificationMode()

setMultiNotificationMode() => Promise<void>

setSingleNotificationMode()

setSingleNotificationMode() => Promise<void>

pushReceivedCallback(...)

pushReceivedCallback(callback: PushwooshNotificationCallback) => Promise<CallbackID>

Param	Type
callback	PushwooshNotificationCallback

Returns: Promise<string>

pushOpenedCallback(...)

pushOpenedCallback(callback: PushwooshNotificationCallback) => Promise<CallbackID>

Param	Type
callback	PushwooshNotificationCallback

Returns: Promise<string>

presentInboxUI(...)

presentInboxUI(params?: Record<string, any> | undefined) => void

Param	Type
params	Record<string, any>

showGDPRConsentUI()

showGDPRConsentUI() => void

showGDPRDeletionUI()

showGDPRDeletionUI() => void

setCommunicationEnabled(...)

setCommunicationEnabled(enabled: boolean) => Promise<{ result: void | string; }>

Param	Type
enabled	boolean

Returns: Promise<{ result: string | void; }>

removeAllDeviceData()

removeAllDeviceData() => Promise<{ result: void | string; }>

Returns: Promise<{ result: string | void; }>

isCommunicationEnabled(...)

isCommunicationEnabled(success: (enabled: boolean) => void) => void

Param	Type
success	(enabled: boolean) => void

isDeviceDataRemoved(...)

isDeviceDataRemoved(success: (removed: boolean) => void) => void

Param	Type
success	(removed: boolean) => void

isAvailableGDPR(...)

isAvailableGDPR(success: (isAvailable: boolean) => void) => void

Param	Type
success	(isAvailable: boolean) => void

Interfaces

PushwooshConfig

Prop	Type
projectid	string
appid	string
serviceName	string

PushwooshTags

Type Aliases

AuthOptions

Record<string, number|string>

Record

Construct a type with a set of properties K of type T

{ [P in K]: T; }

RemoteNotificationStatus

Record<string,string|number|boolean>

PushwooshNotificationCallback

(message: string | null, err?: any): void

CallbackID

string