Samenvatting: Deze gids is bedoeld voor ontwikkelaars die aangepaste applicaties bouwen voor de Speakap Market. Het biedt een voorbeeld manifestbestand dat je als uitgangspunt kunt gebruiken en legt elke kernproperty uit, inclusief de array entries, lokalisatie en icooncodes.
Het voorbeeld manifest sjabloon
De onderstaande JSON-structuur is het blauwdrukconfiguratiebestand voor je aangepaste applicatie. Kopieer deze codeblok en gebruik het als basis, waarbij je de tijdelijke waarden vervangt door de werkelijke waarden van je applicatie.
{
"name": {
"en-US": "Example_Name"
},
"icon": "REPLACE_WITH_ACTUAL_URL",
"permissions": [],
"entries": [
{
"position": "external",
"devices": "desktop",
"url": "REPLACE_WITH_ACTUAL_URL",
"urlAppendNetwork": false,
"label": { "en-US": "Example_Name", "nl-NL": "Example_Name" },
"icon": "\uf1ea"
},
{
"position": "external",
"devices": "ios",
"url": "REPLACE_WITH_ACTUAL_URL",
"urlAppendNetwork": false,
"label": { "en-US": "Example_Name", "nl-NL": "Example_Name" },
"icon": "\uf1ea"
},
{
"position": "external",
"devices": "android",
"url": "REPLACE_WITH_ACTUAL_URL",
"urlAppendNetwork": false,
"label": { "en-US": "Example_Name", "nl-NL": "Example_Name" },
"icon": "\uf1ea"
}
]
}Uitleg van eigenschappen
Wanneer je je manifestbestand van boven naar beneden invult, stel je elke eigenschap als volgt in:
name (globaal)
De primaire naam van de applicatie zoals deze verschijnt in de publieke of private Speakap Market. Vervang "Example_Name" door de naam van jouw applicatie.
- Voorbeeld: "en-US": "Werkrooster"
icon (globaal)
De thumbnail of het logo dat wordt getoond voor je applicatie in de Speakap Market. Vervang REPLACE_WITH_ACTUAL_URL door een absolute URL waar je afbeelding gehost wordt.
- Voorbeeld: "icon": "https://developer.speakap.io/content/themes/developer-portal/assets/images/sa-dev-logo-dark.svg"
entries (array)
Een array van objecten die definiëren waar en hoe de applicatie opent op elk platform (desktop, ios, android).
- url: De webbestemming van het menu-item. Vervang de tijdelijke aanduiding door jouw doel-URL.
- Voorbeeld: "url": "https://www.speakap.com/"
- label: De weergegeven tekst die in het navigatiemenu van de gebruiker in Speakap wordt getoond. Dit ondersteunt meerdere talen voor gelokaliseerde netwerken.
- Voorbeeld: { "en-US": "Speakap", "nl-NL": "Speakap" }
- icon (entry niveau): Het navigatie-icoon dat naast het label in het menu wordt getoond.
Icooncodes
Speakap gebruikt unicode escape codes om applicatie menu-icoontjes te definiëren. Bij het omzetten van hex codes laat je de 0x prefix weg en vervang je deze door \u.
- Conversieformule: Als de icoon glyph code 0xf0a1 is, schrijf je deze als \uf0a1 in je manifest strings.
Nog steeds vastgelopen?
Stuur ons een e-mail op technicalimplementations@speakap.nl met je netwerknaam en je manifestbestand, dan helpen we je verder.