QBESX
Agency-Pad Exports & API
Now with AgencyOS27: a free update for everyone who already owns the pad.
v27.0.2Paid6 Pages
01Client Exports
| Export | Description |
|---|---|
IsPadOpen() | Returns true if the tablet UI is currently open. |
IsPadPoweredOn() | Returns true if the tablet is powered on. |
GetPadData() | Returns the full client-side PadData table. |
GetPadPropEntity() | Returns the entity handle of the held tablet prop, or 0 if not visible. |
IsPadExpanded() | Alias of IsPadOpen() kept for backward compatibility. |
HasCarrierContract() | Returns true when the player has an active carrier data plan on the tablet. |
GetPadState() | Returns table { isOpen, poweredOn, syncEnabled } summarising current tablet status. |
HasPad() | Returns true if the player has the configured tablet item in their inventory. |
RegisterAgencyPayPoint(id, data) | Registers a runtime Agency Pay terminal at a coordinate (markers, blip, checkout payload). |
RemoveAgencyPayPoint(id) | Removes a previously registered Agency Pay terminal by id. |
StartAgencyPayCheckout(data) | Opens the tablet (if needed) and launches an Agency Pay checkout flow with the given payment payload. |
StartCall(contactData) | Starts an outgoing tablet call to the supplied contact ({ name, number, ... }). |
PhoneNotification(title, text, icon, color, timeout, acceptIcon, denyIcon) | Shows an action notification with accept/deny buttons; blocks until the user responds and returns true/false. |
RegisterApp(config) | Puts an app from your own resource on the pad home screen and in the Store. Returns true, or false and an error. |
UnregisterApp(id) | Removes an app added with RegisterApp. |
GetRegisteredApps() | Returns the table of all apps registered by other resources, keyed by id. |
ClosePad() | Closes the pad, for example before your own interface opens. |
ClosePhone() | Same as ClosePad(), under the name the Agency Phone uses, so the same integration code works for both. |
IsPhoneRadioActive() | Returns two values: true while the radio on the pad is playing, and the station that is playing. |
StopPhoneRadio() | Stops the radio on the pad. |
02Server Exports
| Export | Description |
|---|---|
SendMail(identifier, mailData) | Sends a mail to the player's primary mailbox by identifier (returns success). |
usePad(event, item, inventory, slot, data) | ox_inventory hook registered when ESX+ox_inventory is detected; opens the tablet for the inventory holder. |
usePhone(event, item, inventory, slot, data) | ox_inventory hook for the legacy phone item id; opens the tablet for the inventory holder. |
GetMarketPrices() | Returns the current stock and crypto prices of the markets, keyed by market id. |
PushPadData(source) | Sends a fresh copy of the tablet data to this player's pad. Returns false if it could not be built. |
03Events
| Name | Side | Description |
|---|---|---|
agency-pad:client:notify | Client | Shows a tablet notification (title, text, icon, color, timeout, silent). |
agency-pad:client:usePadItem | Client | Opens the tablet when the inventory item is used. |
agency-pad:client:openApp | Client | Asks the tablet to navigate to a custom app by id. |
agency-pad:client:newMailNotify | Client | Notifies the client of a freshly received mail. |
agency-pad:client:hourlyPaycheck | Client | Notifies the client of an hourly business paycheck event. |
agency-pad:server:requestPadData | Server | Requests a fresh tablet data sync for the calling player. |
agency-pad:server:sendMessage | Server | Sends an SMS message (newMsg, targetNumber). |
agency-pad:server:airdropPay | Server | Performs an Agency Airdrop pay-to-nearby-player transfer. |
agency-pad:server:buyDataPlan | Server | Buys a carrier data plan for the player. |
agency-pad:dispatch:create | Server | Creates a tablet dispatch from an emergency call/SMS. |
agency-pad:server:biz:create | Server | Creates a new business/organisation for the player. |
agency-pad:server:biz:adminCreate | Server | Admin creates a business on behalf of another player. |
agency-pad:server:biz:startMission | Server | Starts a configured business mission for the player. |
agency-pad:server:applyToListing | Server | Submits a job application to a business listing. |
agency-pad:server:createMechanicInvoice | Server | Creates a mechanic invoice draft. |
agency-pad:server:sendMechanicInvoicePay | Server | Sends a mechanic invoice to a customer for payment. |
agency-pad:server:mdtCreateInvoice | Server | MDT creates a fine/invoice for a citizen. |