Client exportları

Özel uygulamalar

Deftere kendi uygulamanı ekleyen, açan, sayfasına veri gönderen ve kaldıran client export'ları.

Bu export'lar başka bir resource'ta yapılmış bir uygulamayı defterin uygulama listesine ekler. Adım adım anlatım Özel uygulamalara genel bakış sayfasında. Server tarafı Özel uygulama aksiyonları sayfasında.

Yalnızca Config.CustomApps.Enabled true iken çalışırlar.

#AddCustomApp

Uygulamanı uygulama listesine ekler. Çağıran resource uygulamanın sahibi olur.

lua---@param definition table { identifier, name, ui, icon? }
---@return boolean ok
---@return string idOrError the app id on success, a short reason on failure
exports['fx-pocketbook']:AddCustomApp(definition)
lualocal ok, result = exports['fx-pocketbook']:AddCustomApp({
    identifier = 'ranch_ledger',
    name = 'Ranch Ledger',
    ui = 'ui/index.html',
    icon = 'ui/icon.png',
})
Alan Diğer adı Kurallar
identifier appId Küçük harf, rakam ve _; harfle başlar, en fazla 32 karakter. Yerleşik uygulama id'leri ayrılmıştır.
name label Listede görünen ad. En fazla 64 bayt, boş olamaz.
ui Kendi resource'unun sayfası: 'ui/index.html', 'my-resource/ui/index.html' ya da 'https://cfx-nui-my-resource/ui/index.html'.
icon Kendi resource'undan isteğe bağlı bir görsel, ui ile aynı biçimlerde. Verilmezse defter simgesi görünür.
  • ui ve icon çağıran resource'un içini göstermelidir. .., %, \, boşluk, ?, # içeren ya da / ile başlayan yollar ve başka bir siteye giden bağlantılar reddedilir.
  • Şu durumlarda false döndürür: özel uygulamalar kapalıysa, id geçersiz, ayrılmış ya da kullanılıyorsa (senin ya da başkasının), Config.CustomApps.Maximum sınırına ulaşıldıysa veya ad ya da bir yol geçersizse.
  • Aynı id'yi yeniden kaydetmek false döndürür ve ilk kaydı korur.
  • Resource'un durduğunda uygulaması kaldırılır. Resource başlarken ve [fx-pocketbook:ready](/phone/docs/pocketbook/events/client-events) event'inde yeniden kaydet.
  • Sayfayı, script'lerini, stil dosyalarını ve simgeyi kendi fxmanifest.lua dosyanda files altında listele. Bunun için ui_page tanımlama.

#RemoveCustomApp

Uygulamanı listeden kaldırır. Açıksa kapanır.

lua---@param id string
---@return boolean removed false when the app is not yours or does not exist
exports['fx-pocketbook']:RemoveCustomApp(id)
luaexports['fx-pocketbook']:RemoveCustomApp('ranch_ledger')

#OpenApp

Defteri açar, kapağını açar, sonra senin uygulamanı gösterir. Defter açıksa uygulamana geçer.

lua---@param id string
---@return boolean ok
exports['fx-pocketbook']:OpenApp(id)
luaRegisterCommand('ledger', function()
    exports['fx-pocketbook']:OpenApp('ranch_ledger')
end, false)
  • Uygulama senin değilse ya da defter açılamıyorsa (bkz. [Open](/phone/docs/pocketbook/exports/client/notebook)) false döndürür.
  • Yerleşik bir uygulamayı açmak için [OpenApplication](/phone/docs/pocketbook/exports/client/notebook) kullan.

#SendCustomAppMessage

Uygulamanın sayfası ekrandayken ona veri gönderir. Sayfa bunu Pocketbook.onMessage ile alır.

lua---@param id string
---@param data any table, string, number or boolean
---@return boolean sent
exports['fx-pocketbook']:SendCustomAppMessage(id, data)
luaexports['fx-pocketbook']:SendCustomAppMessage('ranch_ledger', { kind = 'hint', text = 'The cattle are fed.' })
  • Uygulama senin değilse ya da data fazla büyükse false döndürür: JSON olarak 32 KiB'tan büyük, 8 seviyeden derin, bir tabloda 128'den fazla anahtar ya da 16384 bayttan uzun bir string.
  • Mesaj yalnızca o an açık olan sayfaya iletilir. Saklanmaz. Uygulama kapalıysa kaybolur.