indigitall-capacitor-plugin

Capacitor Indigitall Plugin

Install

npm install indigitall-capacitor-plugin
npx cap sync

API

• requestPushPermission()
• getPushPermissionStatus()
• initialize(...)
• deviceGet()
• deviceEnable()
• deviceDisable()
• topicsList()
• topicsSubscribe(...)
• topicsUnsubscribe(...)
• sendCustomEvent(...)
• getPush(...)
• onIndigitallGetPush(...)
• clearViewUrl()
• setDefaultViewUrl(...)
• onMessageReceived(...)
• isPushSecure(...)
• getToken()
• isIndigitallPushNotification(...)
• logIn(...)
• logOut()
• Interfaces
• Type Aliases

requestPushPermission()

requestPushPermission() => Promise<any>

Returns: Promise<any>

getPushPermissionStatus()

getPushPermissionStatus() => Promise<any>

Returns: Promise<any>

initialize(...)

initialize(params: { config: any; }) => Promise<any>

| Param | Type | | ------------ | ----------------------------- | | params | { config: any; } |

Returns: Promise<any>

deviceGet()

deviceGet() => Promise<any>

Returns: Promise<any>

deviceEnable()

deviceEnable() => Promise<any>

Returns: Promise<any>

deviceDisable()

deviceDisable() => Promise<any>

Returns: Promise<any>

topicsList()

topicsList() => Promise<any>

Returns: Promise<any>

topicsSubscribe(...)

topicsSubscribe(params: { topics: string[]; }) => Promise<any>

| Param | Type | | ------------ | ---------------------------------- | | params | { topics: string[]; } |

Returns: Promise<any>

topicsUnsubscribe(...)

topicsUnsubscribe(params: { topics: string[]; }) => Promise<any>

| Param | Type | | ------------ | ---------------------------------- | | params | { topics: string[]; } |

Returns: Promise<any>

sendCustomEvent(...)

sendCustomEvent(params: { customEvent: any; }) => Promise<void>

| Param | Type | | ------------ | ---------------------------------- | | params | { customEvent: any; } |

getPush(...)

getPush(onSuccess: OnPushSuccessType, onError?: OnErrorCallbackType | undefined) => OnPushSuccessType

| Param | Type | | --------------- | ------------------------------------------------------------------- | | onSuccess | OnPushSuccessType | | onError | OnErrorCallbackType |

Returns: OnPushSuccessType

onIndigitallGetPush(...)

onIndigitallGetPush(onSuccess: OnPushSuccessType, onError?: OnErrorCallbackType | undefined) => OnPushSuccessType

| Param | Type | | --------------- | ------------------------------------------------------------------- | | onSuccess | OnPushSuccessType | | onError | OnErrorCallbackType |

Returns: OnPushSuccessType

clearViewUrl()

clearViewUrl() => void

setDefaultViewUrl(...)

setDefaultViewUrl(params: { defaultView: string; }) => void

| Param | Type | | ------------ | ------------------------------------- | | params | { defaultView: string; } |

onMessageReceived(...)

onMessageReceived(onSuccess: OnMessageReceivedSuccessType) => OnMessageReceivedSuccessType

| Param | Type | | --------------- | ------------------------------------------------------------------------------------- | | onSuccess | OnMessageReceivedSuccessType |

Returns: OnMessageReceivedSuccessType

isPushSecure(...)

isPushSecure(params: { notification: any; }) => Promise<any>

| Param | Type | | ------------ | ----------------------------------- | | params | { notification: any; } |

Returns: Promise<any>

getToken()

getToken() => Promise<any>

Returns: Promise<any>

isIndigitallPushNotification(...)

isIndigitallPushNotification(params: { notification: any; }) => Promise<any>

| Param | Type | | ------------ | ----------------------------------- | | params | { notification: any; } |

Returns: Promise<any>

logIn(...)

logIn(param: { externalCode: string; }) => Promise<any>

| Param | Type | | ----------- | -------------------------------------- | | param | { externalCode: string; } |

Returns: Promise<any>

logOut()

logOut() => Promise<any>

Returns: Promise<any>

Interfaces

JSON

An intrinsic object that provides functions to convert JavaScript values to and from the JavaScript Object Notation (JSON) format.

| Method | Signature | Description | | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------- | | parse | (text: string, reviver?: ((this: any, key: string, value: any) => any) | undefined) => any | Converts a JavaScript Object Notation (JSON) string into an object. | | stringify | (value: any, replacer?: ((this: any, key: string, value: any) => any) | undefined, space?: string | number | undefined) => string | Converts a JavaScript value to a JavaScript Object Notation (JSON) string. | | stringify | (value: any, replacer?: (string | number)[] | null | undefined, space?: string | number | undefined) => string | Converts a JavaScript value to a JavaScript Object Notation (JSON) string. |

Type Aliases

OnPushSuccessType

(push: Push): void

Push

{ title: string; body: string; image: string; data: string; securedData: string; action: PushAction; buttons: [PushButton]; }

PushAction

{ url: string | null; app: string | null; market: string | null; share: string | null; call: string | null; noAction: string | null; clickedButton: number | null; }

PushButton

{ label: string; action: PushAction; }

OnErrorCallbackType

(error: ErrorCallback): void

ErrorCallback

{ message: string; }

OnMessageReceivedSuccessType

(json: JSON): void