2.0.5 • Published 4 months ago

capacitor-plugin-notifyvisitors v2.0.5

Weekly downloads
-
License
MIT
Repository
-
Last release
4 months ago

capacitor-plugin-notifyvisitors

A Capacitor Plugin of NotifyVisitors SDK for push notifications and surveys

Install

npm install capacitor-plugin-notifyvisitors
npx cap sync

API

showInAppMessage(...)

showInAppMessage(options: { tokens: object; customRules: object; }) => Promise<{ callback: string; }>
ParamType
options{ tokens: object; customRules: object; }

Returns: Promise<{ callback: string; }>


show(...)

show(options: { tokens: object; customRules: object; }) => Promise<{ callback: string; }>
ParamType
options{ tokens: object; customRules: object; }

Returns: Promise<{ callback: string; }>


openNotificationCenter(...)

openNotificationCenter(options: { appInboxInfo: object; dismissValue: string; }) => Promise<{ callback: string; }>
ParamType
options{ appInboxInfo: object; dismissValue: string; }

Returns: Promise<{ callback: string; }>


showNotifications(...)

showNotifications(options: { appInboxInfo: object; dismissValue: string; }) => Promise<{ callback: string; }>
ParamType
options{ appInboxInfo: object; dismissValue: string; }

Returns: Promise<{ callback: string; }>


event(...)

event(options: { eventName: string; attributes: object; lifeTimeValue: string; scope: string; }) => Promise<{ callback: string; }>
ParamType
options{ eventName: string; attributes: object; lifeTimeValue: string; scope: string; }

Returns: Promise<{ callback: string; }>


userIdentifier(...)

userIdentifier(options: { userId: string; attributes: object; }) => Promise<{ callback: string; }>
ParamType
options{ userId: string; attributes: object; }

Returns: Promise<{ callback: string; }>


setUserIdentifier(...)

setUserIdentifier(options: { attributes: object; }) => Promise<{ callback: string; }>
ParamType
options{ attributes: object; }

Returns: Promise<{ callback: string; }>


knownUserIdentified()

knownUserIdentified() => Promise<{ callback: string; }>

Returns: Promise<{ callback: string; }>


autoStartAndroid()

autoStartAndroid() => Promise<{ callback: string; }>

Returns: Promise<{ callback: string; }>


getNvUID()

getNvUID() => Promise<{ callback: string; }>

Returns: Promise<{ callback: string; }>


createNotificationChannel(...)

createNotificationChannel(options: { channelId: string; channelName: string; channelDescription: string; channelImportance: string; enableLights: boolean; shouldVibrate: boolean; lightColor: string; soundFileName: string; }) => Promise<{ callback: string; }>
ParamType
options{ channelId: string; channelName: string; channelDescription: string; channelImportance: string; enableLights: boolean; shouldVibrate: boolean; lightColor: string; soundFileName: string; }

Returns: Promise<{ callback: string; }>


deleteNotificationChannel(...)

deleteNotificationChannel(options: { channelId: string; }) => Promise<{ callback: string; }>
ParamType
options{ channelId: string; }

Returns: Promise<{ callback: string; }>


createNotificationChannelGroup(...)

createNotificationChannelGroup(options: { groupId: string; groupName: string; }) => Promise<{ callback: string; }>
ParamType
options{ groupId: string; groupName: string; }

Returns: Promise<{ callback: string; }>


deleteNotificationChannelGroup(...)

deleteNotificationChannelGroup(options: { groupId: string; }) => Promise<{ callback: string; }>
ParamType
options{ groupId: string; }

Returns: Promise<{ callback: string; }>


getRegistrationToken()

getRegistrationToken() => Promise<{ callback: string; }>

Returns: Promise<{ callback: string; }>


inAppReview()

inAppReview() => Promise<{ callback: string; }>

Returns: Promise<{ callback: string; }>


getNotificationCenterCount(...)

getNotificationCenterCount(options: { appInboxInfo: object; }) => Promise<{ callback: string; }>
ParamType
options{ appInboxInfo: object; }

Returns: Promise<{ callback: string; }>


notificationCount()

notificationCount() => Promise<{ callback: string; }>

Returns: Promise<{ callback: string; }>


subscribePushCategory(...)

subscribePushCategory(options: { categoryArray: Array<string>; unsubscribeSignal: boolean; }) => Promise<{ callback: string; }>
ParamType
options{ categoryArray: string[]; unsubscribeSignal: boolean; }

Returns: Promise<{ callback: string; }>


getNotificationDataListener()

getNotificationDataListener() => Promise<{ callback: string; }>

Returns: Promise<{ callback: string; }>


getNotificationData()

getNotificationData() => Promise<{ callback: string; }>

Returns: Promise<{ callback: string; }>


getEventSurveyInfo()

getEventSurveyInfo() => Promise<{ callback: string; }>

Returns: Promise<{ callback: string; }>


scrollViewDidScroll()

scrollViewDidScroll() => Promise<{ callback: string; }>

Returns: Promise<{ callback: string; }>


pushPermissionPrompt(...)

pushPermissionPrompt(options: { pushPromptInfo: PushPromptInfo; }) => Promise<{ callback: string; }>
ParamType
options{ pushPromptInfo: PushPromptInfo; }

Returns: Promise<{ callback: string; }>


nativePushPermissionPrompt()

nativePushPermissionPrompt() => Promise<{ callback: string; }>

Returns: Promise<{ callback: string; }>


addListener('notificationReceived', ...)

addListener(eventName: 'notificationReceived', listenerFunc: NotificationReceivedListener) => Promise<PluginListenerHandle> & PluginListenerHandle
ParamType
eventName'notificationReceived'
listenerFuncNotificationReceivedListener

Returns: Promise<PluginListenerHandle> & PluginListenerHandle


addListener('chatBotResponse', ...)

addListener(eventName: 'chatBotResponse', listenerFunc: ChatBotResponseListener) => Promise<PluginListenerHandle> & PluginListenerHandle
ParamType
eventName'chatBotResponse'
listenerFuncChatBotResponseListener

Returns: Promise<PluginListenerHandle> & PluginListenerHandle


addListener('eventSurveyResponse', ...)

addListener(eventName: 'eventSurveyResponse', listenerFunc: EventSurveyResponseListener) => Promise<PluginListenerHandle> & PluginListenerHandle
ParamType
eventName'eventSurveyResponse'
listenerFuncEventSurveyResponseListener

Returns: Promise<PluginListenerHandle> & PluginListenerHandle


addListener('inAppResponse', ...)

addListener(eventName: 'inAppResponse', listenerFunc: InAppListener) => Promise<PluginListenerHandle> & PluginListenerHandle
ParamType
eventName'inAppResponse'
listenerFuncInAppListener

Returns: Promise<PluginListenerHandle> & PluginListenerHandle


addListener('eventResponse', ...)

addListener(eventName: 'eventResponse', listenerFunc: NvEventListener) => Promise<PluginListenerHandle> & PluginListenerHandle
ParamType
eventName'eventResponse'
listenerFuncNvEventListener

Returns: Promise<PluginListenerHandle> & PluginListenerHandle


addListener('centerCallback', ...)

addListener(eventName: 'centerCallback', listenerFunc: NvCenterCallbackEventListener) => Promise<PluginListenerHandle> & PluginListenerHandle
ParamType
eventName'centerCallback'
listenerFuncNvCenterCallbackEventListener

Returns: Promise<PluginListenerHandle> & PluginListenerHandle


addListener('knownUserIdentified', ...)

addListener(eventName: 'knownUserIdentified', listenerFunc: NvKnownUserIdentifiedListener) => Promise<PluginListenerHandle> & PluginListenerHandle
ParamType
eventName'knownUserIdentified'
listenerFuncNvKnownUserIdentifiedListener

Returns: Promise<PluginListenerHandle> & PluginListenerHandle


Interfaces

Array

PropTypeDescription
lengthnumberGets or sets the length of the array. This is a number one higher than the highest index in the array.
MethodSignatureDescription
toString() => stringReturns a string representation of an array.
toLocaleString() => stringReturns a string representation of an array. The elements are converted to string using their toLocalString methods.
pop() => T | undefinedRemoves the last element from an array and returns it. If the array is empty, undefined is returned and the array is not modified.
push(...items: T[]) => numberAppends new elements to the end of an array, and returns the new length of the array.
concat(...items: ConcatArray<T>[]) => T[]Combines two or more arrays. This method returns a new array without modifying any existing arrays.
concat(...items: (T | ConcatArray<T>)[]) => T[]Combines two or more arrays. This method returns a new array without modifying any existing arrays.
join(separator?: string | undefined) => stringAdds all the elements of an array into a string, separated by the specified separator string.
reverse() => T[]Reverses the elements in an array in place. This method mutates the array and returns a reference to the same array.
shift() => T | undefinedRemoves the first element from an array and returns it. If the array is empty, undefined is returned and the array is not modified.
slice(start?: number | undefined, end?: number | undefined) => T[]Returns a copy of a section of an array. For both start and end, a negative index can be used to indicate an offset from the end of the array. For example, -2 refers to the second to last element of the array.
sort(compareFn?: ((a: T, b: T) => number) | undefined) => thisSorts an array in place. This method mutates the array and returns a reference to the same array.
splice(start: number, deleteCount?: number | undefined) => T[]Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.
splice(start: number, deleteCount: number, ...items: T[]) => T[]Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.
unshift(...items: T[]) => numberInserts new elements at the start of an array, and returns the new length of the array.
indexOf(searchElement: T, fromIndex?: number | undefined) => numberReturns the index of the first occurrence of a value in an array, or -1 if it is not present.
lastIndexOf(searchElement: T, fromIndex?: number | undefined) => numberReturns the index of the last occurrence of a specified value in an array, or -1 if it is not present.
every<S extends T>(predicate: (value: T, index: number, array: T[]) => value is S, thisArg?: any) => this is S[]Determines whether all the members of an array satisfy the specified test.
every(predicate: (value: T, index: number, array: T[]) => unknown, thisArg?: any) => booleanDetermines whether all the members of an array satisfy the specified test.
some(predicate: (value: T, index: number, array: T[]) => unknown, thisArg?: any) => booleanDetermines whether the specified callback function returns true for any element of an array.
forEach(callbackfn: (value: T, index: number, array: T[]) => void, thisArg?: any) => voidPerforms the specified action for each element in an array.
map<U>(callbackfn: (value: T, index: number, array: T[]) => U, thisArg?: any) => U[]Calls a defined callback function on each element of an array, and returns an array that contains the results.
filter<S extends T>(predicate: (value: T, index: number, array: T[]) => value is S, thisArg?: any) => S[]Returns the elements of an array that meet the condition specified in a callback function.
filter(predicate: (value: T, index: number, array: T[]) => unknown, thisArg?: any) => T[]Returns the elements of an array that meet the condition specified in a callback function.
reduce(callbackfn: (previousValue: T, currentValue: T, currentIndex: number, array: T[]) => T) => TCalls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
reduce(callbackfn: (previousValue: T, currentValue: T, currentIndex: number, array: T[]) => T, initialValue: T) => T
reduce<U>(callbackfn: (previousValue: U, currentValue: T, currentIndex: number, array: T[]) => U, initialValue: U) => UCalls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
reduceRight(callbackfn: (previousValue: T, currentValue: T, currentIndex: number, array: T[]) => T) => TCalls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
reduceRight(callbackfn: (previousValue: T, currentValue: T, currentIndex: number, array: T[]) => T, initialValue: T) => T
reduceRight<U>(callbackfn: (previousValue: U, currentValue: T, currentIndex: number, array: T[]) => U, initialValue: U) => UCalls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

ConcatArray

PropType
lengthnumber
MethodSignature
join(separator?: string | undefined) => string
slice(start?: number | undefined, end?: number | undefined) => T[]

PluginListenerHandle

PropType
remove() => Promise<void>

NotificationReceivedEvent

PropType
nv_notificationany

ChatBotResponseEvent

PropType
nv_chatBot_responseany

EventSurveyResponseEvent

PropType
nv_event_surveyany

InAppEvent

PropType
nv_showany

NvEvent

PropType
nv_eventany

NvCenterCallbackEvent

PropType
nv_center_callbackany

NvKnownUserIdentified

PropType
nv_known_userany

Type Aliases

NotificationReceivedListener

(event: NotificationReceivedEvent): void

ChatBotResponseListener

(event: ChatBotResponseEvent): void

EventSurveyResponseListener

(event: EventSurveyResponseEvent): void

InAppListener

(event: InAppEvent): void

NvEventListener

(event: NvEvent): void

NvCenterCallbackEventListener

(event: NvCenterCallbackEvent): void

NvKnownUserIdentifiedListener

(event: NvKnownUserIdentified): void

2.0.5

4 months ago

2.0.4

9 months ago

2.0.3

11 months ago

2.0.2

12 months ago

2.0.1

1 year ago

1.8.0

2 years ago

1.2.0

2 years ago

1.7.0

2 years ago

1.6.0

2 years ago

1.5.0

2 years ago

1.4.0

2 years ago

1.3.0

2 years ago

1.1.0

2 years ago

1.0.0

3 years ago