InboxSDK.*

The functions in this class are only used for load related functionality like loading the SDK itself or other external scripts.

load()

Method returns:

Promise

Loads InboxSDK remotely and prepares it to be used. Returns a promise which resolves with the SDK interface (see usage examples under "Structuring Your App") when the SDK is loaded and ready to be used.

Parameter	Description	Type
version	The API version of the SDK to use. The recommended value right now is 2.	number
appId	The AppId that you registered for on the AppId Registration page.	string
options	Optional options object	LoadOptions

loadScript()

Method returns:

Promise

Loads a remote script into the extension's content script space and evals it. Returns a promise which resolves when the script is finished downloading and eval'ing.

Parameter	Description	Type
url	The URL of the remote script to load	string
options	Optional options object	LoadScriptOptions

LoadOptions

Type, used by: InboxSDK.load()

Property	Description	Type
appName	The name of your app. This is used by several methods in the SDK.	string, default: null
appIconUrl	The URL of the icon of your app. Can be HTTPS or a chrome runtime url.	string, default: null
suppressAddonTitle	The name of the Gmail Add-On you want to hide. Use this if you have both an extension and a Gmail Add-On that provide similar functionality.	string, default: null

LoadScriptOptions

Type, used by: InboxSDK.loadScript()

Property	Description	Type
nowrap	The name of your app. This is used by several methods in the SDK.	boolean, default: false