launch domain

iwa

Stories addressed

• Open a new instance of an Integrated Web App, optionally at a particular route

URL

liquidstate://launch/iwa?request=URLENCODED_REQUEST_OBJECT

Request data

Property name	Type	Required	Description
webapp_id	String	No	Default value: current webapp id (or null when currently in native view)
entrypoint	String	No	Default value: "default"
route	String	No	Default value: "/"
transition	String	No	Possible values: "push" "replace" Specifies how the next view or activity should be presented. The default is "push", which is equivalent to the platform's default (e.g. "slide from the right hand side on iOS").
latest	Boolean	No	Default value: true if navigate to other webapp id or no local copy of the webapp false if navigating to the same webapp id

Response

No response, the native app will simply launch the IWA with the specified transition.

document

Stories addressed

• Navigate from an IWA to open/reading documents

Note: currently, native apps will first check whether a document is locally present on the device and up to date before trying to open it for reading. If it is not, the native app will download the document, presenting to the user a native download progress UI. In an upcoming version of native apps, this will be removed and additional IWA events will be supproted in the "documents" domain to deal with the downloading/updating of documents.

URL

liquidstate://launch/document?request=URLENCODED_REQUEST_OBJECT

Request data

Property name	Type	Required	Description
product_id	String	Yes	The unique identifier (a.k.a. "product id") of the document to open
page_slug	String	No	Default value: first page of the document

Example request data

{
    "product_id": "com.mycompany.awesomedoc",
    "page_slug": "page-4"
}

Response

No response, the native app will simply launch the document viewer (as noted above it may first download the document if needed).

email

Stories addressed

• Open the device's built-in email composing client, optionally pre-populating fields.

URL

liquidstate://launch/email?request=URLENCODED_REQUEST_OBJECT

Request data

Property name	Type	Required	Description
to	String	No	A comma-separated list of email addresses
cc	String	No	A comma-separated list of email addresses
bcc	String	No	A comma-separated list of email addresses
subject	String	No	One line of text to pre-populate the subject of the email
body	String	No	One or more lines of text to pre-populate the body of the email

Example request data

{
    "to": "[e-mail]",
    "subject": "Could you help me out?",
    "body": "Great mobile app!\n\nI just have a few questions..."
}

Response

No response, the native app will simply launch the device's standard email composing interface. The user should get back to the app after successfully sending an email or dismissing this interface.