Parallelix
DemoGitRoadmapAbout Us
  • Get Started
    • Welcome to Parallelix
    • Installation and Usage
    • Develop your modules
  • Roadmap
  • API Reference
    • General Client
    • VK Bridge (Mini Apps)
    • Telegram Mini Apps
    • PWA and Web Applications
    • WeChat
    • Direct Games
    • Yandex Games
  • Android and iOS (Apache Cordova)
  • Windows, Mac, Linux (Electron)
  • About
    • Product Page
    • GitHub
    • Our Website
Powered by GitBook
On this page
  • What is Web application (PWA)
  • Web Module (ParallelixWeb)
  • Platform Specific configuration
  • API Reference
  1. API Reference

PWA and Web Applications

This is the base module for running your web applications. It will be used if your web application has been run outside of your defined platforms (default).

PreviousTelegram Mini AppsNextWeChat

Last updated 2 months ago

What is Web application (PWA)

This is a basic module that applies to all platforms, except for those you have specified in the configuration of the object.

For example, if the platforms you selected were vk and telegram, this module will be used outside these platforms.

This module is support PWA methods.


Web Module (ParallelixWeb)

Module Name: "web" (default)

PlatformSpecificParameters

Below we have described each method available for calling, its parameters with a reference to the official documentation and the name of the official method.


Platform Specific configuration

Field
Type
Description

manifest

string

Path to PWA manifest file

API Reference

Method
Description
Parameters

GetLaunchParams

Get current browser search parameters (query)

Returns in onSuccess:

Key Value object with window arguments

HandleEvents

Handle all "message" events from current window.

-

GetClientInfo

Returns information about current browser and client

Returns in onSuccess:

Information about current clinet (version, platform, userAgent, userAgentData)

ToggleFullscreen

Toggle browser / pwa fullscreen mode

boolean state of fullscreen

AddToHomeScreen

Adding current PWA on home screen. Can't work without PWA manifest in your application.

onSuccess and onError callbacks.

AddToFavorites

Add current page to favourites in browser

Parameters are empty. Has onSuccess and onError callbacks

OpenLink

Open link in new window

url [string]

GetStorage

Get local storage item

key [string] key name

SetStorage

Set local storage item

key [string] key name

value [dynamic] storage value

RequestLocation

Request user geolocation

Return an object in onSuccess with parameters from:

CloseApplication

Close browser window / PWA

-

GoBack

Go to previous page / hash

Wrapper of:

window.history.back();

This module will always be loaded by default, so it must be available for the Parallelix client. .

Any of our modules inherits from - a virtual class describing a unified SDK structure. Below we have described the peculiarities of working with the module, as well as the differences and description of API parameters for the current module.

These are parameters that are passed inside some module methods. When working with them, you need to create subobjects as . Inside this subobject are the parameters described in the documentation of a particular platform.

See the General Client section for downloading paths
navigator.geolocation.getCurrentPosition
Parallelix
ParallelixWrapper
described in the documentation on working with such parameters