Mobile sdk best practices

Mobile SDK Best PracticesGal Keidar

What is mobile SDK?Mobile SDK is a library that serves a set of core capabilities for an external hosting application

SDK best practiceMobile SDK must adhere to certain basic rules to be indicated as efficient, stable and trusted

Minimum use of resourcesDon’t drain the battery

Minimum use of resourcesSave user’s data plan● Small payloads● Batch requests● Communication type

(poll/long poll/websockets)

Minimum use of resourcesDon’t use local storage it you don’t have to. If you do - use it efficiently and make sure to purge when you’re done

Minimum use of resourcesBe performant

Minimum use of resourcesBe as small and light as you can

Minimum use of resourcesDisable logs on released version

Easy to integrateOne line initialization - SDK.Init(API_KEY)

Easy to integrateFollow native language conventions

Easy to integrateMeaningful APIs and callbacks names

Easy to integrateGive feedback to your host app● Return values● Descriptive error

messages

Easy to integrateBe generous with comments

Easy to integrateSupport dependency managers like Cocoapods, Maven, Carthage...

Maximum compatibilitySupport all relevant OS versions

Maximum compatibilitySupport all most popular devices

Complete transparencyLet your user know what you’re doing inside their app

Complete transparencyWrite clear, efficient code with lots of comments - it’s your company’s face

Complete transparencyDon’t try to ‘hide’ anything

Complete transparencyDon’t use data you’re not suppose to

Don’t crash the host appEver!

Don’t ask the user for permissionsLet the host app do it for you or do it yourself if it approves you to

Avoid using 3rd party libsAs much as you can.Your users will hold you responsible for their faults