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 VK Mini Apps (VK Bridge)
  • VK Bridge Platform Module (ParallelixVK)
  • Platform Specific configuration
  • API Reference
  • Call directly methods from VK Bridge
  1. API Reference

VK Bridge (Mini Apps)

Description of SDK methods allowing to work with VK Mini Apps through interaction with Parallelix unified interface

PreviousGeneral ClientNextTelegram Mini Apps

Last updated 2 months ago

What is VK Mini Apps (VK Bridge)

VK Mini Apps is an open platform of embeddable cross-platform applications that extend the capabilities of the VKontakte website and app. We call such applications mini-apps.

VK Mini Apps relies on a universal approach and uses standard web technologies: HTML, JavaScript, CSS to develop mini-apps.


VK Bridge Platform Module (ParallelixVK)

Module Name: "vk"

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

No specific configuration provided for this platform

API Reference

Method
Official Method Link
Parameters / Callbacks Data

GetLaunchParams

From official documentation (structure and naming)

HandleEvents

From official documentation (structure and naming)

GetClientInfo

From official documentation (structure and naming)

AddToHomeScreen

Not implemented on PC version of VK Mini Apps!

From official documentation (structure and naming)

OpenPaymentForm

From official documentation (structure and naming)

CallCustomMethod

Call any method from VK Bridge with our without parameters (for Example VKWebAppAddToHomeScreen)

From official documentation (structure and naming)

AddToFavorites

From official documentation (structure and naming)

ShareApplication

From official documentation (structure and naming)

PublishStory

From official documentation (structure and naming) + mediaURL for uploading in story

OpenLink

-

Open link in new window (browser) with URL [string] parameter

AllowNotifications

From official documentation (structure and naming)

GetStorage

From official documentation (structure and naming)

SetStorage

From official documentation (structure and naming)

CloseApplication

From official documentation (structure and naming)

ShowQRReader

From official documentation (structure and naming)

RequestUserPhone

From official documentation (structure and naming)

RequestUserEmail

From official documentation (structure and naming)

GetUserInfo

From official documentation (structure and naming)

RequestLocation

From official documentation (structure and naming)

RequestAuthToken

From official documentation (structure and naming)

CallAPI

From official documentation (structure and naming)

GoBack

-

Go to previous page / hash or close application


Call directly methods from VK Bridge

To query methods directly, using the same syntax as in the official documentation, use the following approach:

// Parallelix Direct Calls
client.Platform.Invoker.[YOUR_METHOD]

// Equivalient of
vkBridge.[FIELD_OR_METHOD]

.

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.

All events passed from VK Bridge library. See .

You can learn more here
VKWebAppGetLaunchParams
example of events
VKWebAppGetClientVersion
VKWebAppAddToHomeScreen
KWebAppOpenPaymentForm
VKWebAppAddToFavorites
VKWebAppAddToFavorites
VKWebAppShowStoryBox
VKWebAppAllowNotifications
VKWebAppStorageGetKeys
VKWebAppStorageSet
VKWebAppClose
VKWebAppOpenCodeReader
VKWebAppGetPhoneNumber
VKWebAppGetEmail
VKWebAppGetUserInfo
VKWebAppGetGeodata
VKWebAppGetAuthToken
VKWebAppCallAPIMethod
ParallelixWrapper
described in the documentation on working with such parameters