# Client Exports ## **Notification** ### **Send Notification** ```lua local NotifData = { title = "Notification header", -- Notification header message = "Notification Message", -- Notification content message icon = '/html/img/icons/messages.png', -- Icon of the notification duration = 5000, -- specify how many seconds, type = "success", -- the home screen will also appear on the notification side. buttonactive = false, -- Activate if you want to use the button function button = { buttonEvent = "gksphone:client:Test", -- event name to use if the button approves buttonData = "test", -- If you want to transfer any data in the button } } exports["gksphone"]:Notification(NotifData) ``` ## Mail ### Send Mail ```lua local waitingDelivery = { location = { x = 0, y = 0, z = 0 }, name = "Test Location" } local MailData = { sender = 'GKSHOP', image = '/html/img/icons/mail.png', subject = "GKSPHONE", message = 'TEST', button = { --- If you don't want it to be a button, please remove it. enabled = true, buttonEvent = "gksphone:client:mailtest", buttonData = waitingDelivery, -- data buttonname = "Test Button" } } exports["gksphone"]:SendNewMail(MailData) ------ RegisterNetEvent("gksphone:client:mailtest", function (data) debugprint("gksphone:client:mailtest") print(data.name) -- Test Location print(data.location) -- { x = 0, y = 0, z = 0 } end) ``` ## Call ### Create Call ```lua local options = { number = "1111", --string videoCall = true, -- true or false / boolean hideNumber = false, -- true or false / boolean } exports["gksphone"]:CreateCall(options) ``` ### End Call ```lua exports["gksphone"]:EndCall() ``` ### Is In Call ```lua local inCall = exports["gksphone"]:IsInCall() print(inCall) -- true or false ``` ### CreateCallNumber 
-- Do not use the number in the service application
---@class IncomingCall
---@field id string
---@field accept fun()
---@field deny fun()
local createcall, reason = exports['gksphone']:CreateCallNumber("911", {
    displayName = "Police",
    onCall = function(incomingCall)
        print("Incoming call from: " .. incomingCall.id)
        Wait(6000)  -- 6sn
        incomingCall.accept() -- Automatically accept the call
    end,
    onEnd = function()
        print("Call ended")
    end
})
if createcall then
    print("Create call created successfully")
else
    print("Failed to create custom call")
end
### RemoveCallNumber ```lua local removecall, reason = exports['gksphone']:RemoveCallNumber("911") if removecall then print("Call deleted successfully") else print(reason) end ``` ### CallEndCustom ```lua exports['gksphone']:CallEndCustom() ``` ## Custom App ### Add Custom App ```lua exports['gksphone']:AddCustomApp({ name = "MyApp", -- (required) Unique app name appurl = "https://cfx-nui-my-resource/ui/index.html", -- (required) App iframe URL icons = "https://cfx-nui-my-resource/ui/icon.png", -- App icon description = "My awesome app", -- App Store description show = true, -- Show in App Store (default: true) startapp = false, -- Auto-add to home page (default: false) signal = false, -- Require phone signal allowjob = {}, -- Job whitelist e.g. { "police", "ambulance" } blockedjobs = {}, -- Job blacklist e.g. { "unemployed" } labelLangs = { -- Localized app name (optional, falls back to name) tr = "Uygulamam", en = "My App", de = "Meine App" }, -- ▶ Lifecycle Callbacks (optional) onOpen = function(phoneUniqueId, phoneNumber) print(("App opened | Phone: %s | Number: %s"):format(phoneUniqueId, phoneNumber)) end, onClose = function(phoneUniqueId, phoneNumber) print(("App closed | Phone: %s | Number: %s"):format(phoneUniqueId, phoneNumber)) end }) ``` ## Phone ### isPhoneOpen ```lua local isPhoneOpen = exports["gksphone"]:isPhoneOpen() print(isPhoneOpen) -- true / false ``` ### PhoneOpen In order for the phone to be open, a player must first open it from the inventory. ```lua exports["gksphone"]:PhoneOpen() ``` ### PhoneClose ```lua exports["gksphone"]:PhoneClose() ``` ### PhoneOpenBlock Prevent the phone from turning on ```lua local reason = "Phone cannot be used while handcuffed" exports["gksphone"]:PhoneOpenBlock(reason) ``` ### PhoneOpenUnBlock If you have blocked the phone from turning on, you can activate it again with this export. ```lua exports["gksphone"]:PhoneOpenUnBlock() ``` ### PhoneOpenBlockStatus ```lua local status, reason = exports["gksphone"]:PhoneOpenBlockStatus() print(status, reason) -- true/false, reason ``` ### PhoneNumber ```lua local phoneNumber = exports["gksphone"]:PhoneNumber() print(phoneNumber) -- nil or 5555555 ``` ### PhoneUniqueId ```lua local phoneUniqId = exports["gksphone"]:PhoneUniqueId() print(phoneUniqId) -- GKS2222222 ``` ### Is Camera Open ```lua local isCameraOpen = exports["gksphone"]:IsCameraOpen() print(isCameraOpen) -- true or false ``` ## Services ### Send Report ```lua local reportMessage = "Report Message" local reportPhoto = "Image Link" or nil local job = "ambulance" -- job code local anonymous = false -- or true exports["gksphone"]:SendReport(reportMessage, reportPhoto, job, anonymous) ``` ## Battery ### GetPhoneBattery ```lua local battery = exports["gksphone"]:GetPhoneBattery() print(battery) -- The battery percentage, 0-100 ``` ### SetPhoneBattery ```lua local battery = 100 -- The battery percentage, 0-100 exports["gksphone"]:SetPhoneBattery(battery) ``` ### SavePhoneBattery ```lua local battery = 100 -- The battery percentage, 0-100 exports["gksphone"]:SavePhoneBattery(battery) ``` ### ToggleCharging ```lua local charging = true -- true or false exports["gksphone"]:ToggleCharging(charging) ``` ### IsPhoneBatteryDead ```lua local isBatteryDead = exports["gksphone"]:IsPhoneBatteryDead() print(isBatteryDead) -- true or false / If the phone has 0% battery ``` ### IsPhoneCharging ```lua local isCharging = exports["gksphone"]:IsPhoneCharging() print(isCharging) -- true or false ``` ## Signal You must enable Config.Signal (`gksphone/config/signal/config.lua`) to use Export. **Signal requires** [**polyzone**](https://github.com/mkafrin/PolyZone/releases) ### addSignal ```lua local coord = vec3(-1378.91, -74.53, 51.29) -- v3 local radius = 5 local signalId = exports["gksphone"]:addSignal(coord, radius) print(signalId) -- This information is required to remove the region. ``` ### destroySignal ```lua exports["gksphone"]:destroySignal(signalId) ``` ## Map/GPS ### AddMapLocation ```lua exports['gksphone']:AddMapLocation({ id = 'biz_1', position = vector2(x, y), name = '24/7', description = 'Open' }) ``` ### RemoveMapLocation ```lua exports['gksphone']:RemoveMapLocation('biz_1') ``` ### UpdateMapLocation ```lua exports['gksphone']:UpdateMapLocation('biz_1', { position = vector2(x, y) }) ``` ## Misc ### heavyJammer This export renders the phone unusable and only a message section appears in the middle of the screen. ```lua local status = true -- true or false local message = "The message you want to write on the screen" local phoneUniqueId = "GKS22222" -- No Required exports["gksphone"]:heavyJammer(status, message, phoneUniqueId) -- Jam local player's phone (non-persistent, client-side only) exports['gksphone']:heavyJammer(true, "No signal") -- Jam a specific phone (persistent) exports['gksphone']:heavyJammer(true, "Signal blocked", "TARGET_PHONE_ID") ``` ### ToogleFocus ```lua local status = true -- true or false exports["gksphone"]:ToggleFocus(status) ``` --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.gkshop.org/gksphone-v2/exports-and-events/client-exports.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.