Skip to content
This repository has been archived by the owner on May 22, 2020. It is now read-only.

RVM Protocol

Xavier O'Neil edited this page May 31, 2017 · 1 revision

Basic Envelope

{
    topic: string,
    messageId: string,
    payload: any // this is generally an object with at least an `action` key
}

Example call

This one is for fin.desktop.Application.createFromManifest

{
    topic: 'applicaiton',
    messageId: 'dcc730ac-5def-42a3-bd6d-5195c08ac43a',
    payload: {
        action: 'launch-app',
        sourceUrl: 'https://myapp.com/config.json',
        data: {
            configUrl: 'https://myotherapp.com/json'
        }
    }
}

Future Runtime <-> RVM integration

The following payload will be sent upon app launch or external adapter connection:

{
    topic: 'applicaiton',
    messageId: string,
    payload: {
        action: 'license-info',
        sessionId: string,
        parentApp: {
            sourceUrl: string
        },
        sourceUrl: string,
        licenseKey: string,
        client: {
            type: 'dotnet' | 'java' | 'air' | 'node' | 'js',
            version: string,
            pid: number
        }
    }
}