@sodyo/cordova-plugin-sodyo-sdk

1.3.3 • Public • Published

Sodyo SDK Cordova Plugin that wraps Sodyo sdk for android and ios

SodyoSDK for iOS v 3.54.22

SodyoSDK for Android v 3.54.27

Install

Requires Cordova > 5.x.x

Requires multidex support

cordova plugin add cordova-plugin-enable-multidex

Install the plugin

cordova plugin add @sodyo/cordova-plugin-sodyo-sdk

Initialization and quick start

Init the plugin with your Sodyo App Key project token with

SodyoSDK.init(your-app-key,
    function(){ /* successful init callback */ },
    function(){ /* fail init callback */})

Set the Sodyo error listener

SodyoSDK.setErrorListener(
    function(err){ /* fail callback */ }
)

Open the Sodyo scanner

SodyoSDK.start(
    function(markerData){ /* data content callback */ },
    function(){ /* fail */}
)

Set Sodyo event listener (events from scanner)

interface IEventData {
    MarkerValue: string
    ActionType?: string // for example, 'CLOSE'
    Parameters?: { [key: string]: string } // for example, { "color":"#ffffff" }
}

const unsubscribe = SodyoSDK.setSodyoEventListener((eventName, eventData) => {
...
})

unsubscribe()

Close Sodyo scanner

SodyoSDK.close()

Load marker by Id

SodyoSDK.performMarker(markerId)

Personal User Information

SodyoSDK.setUserInfo(userInfo)

User Identification (ID)

SodyoSDK.setAppUserId(userId)

Setting Scanner Preferences

SodyoSDK.setScannerParams(scannerPreferences)

Personalized Content

SodyoSDK.setCustomAdLabel(label)

The label may include one or more tags in comma-separated values (CSV) format as follows: “label1,label2,label3”

Customizing the scanner user interface

// set any html (with css)
SodyoSDK.setOverlayView('<a href="sodyosdk://handleClose">Close</a>') 

// define a handler for the button
SodyoSDK.setOverlayCallback('handleClose', () => { /* do something */ });

Setting visibility of the Sodyo logo

SodyoSDK.setSodyoLogoVisible(false)

Package Sidebar

Install

npm i @sodyo/cordova-plugin-sodyo-sdk

Weekly Downloads

1

Version

1.3.3

License

MIT

Unpacked Size

28.3 kB

Total Files

10

Last publish

Collaborators

  • shtruk
  • b.taranenko
  • ryagur
  • shalomman
  • tomersodyo
  • nicolasbrainway