Browse docs

Exports

Client and server exports provided by Free Phone, with arguments, return values, security boundaries, and complete Lua examples.

Choose the execution side or feature below. These exports belong to sky_phone; Base provider bridges are listed separately in Base Exports.

This page documents the supported public integration calls. Client exports must run in a client script and server exports must run in a server script. Internal NUI callbacks and net events are not public APIs.

Keep the resource folder named sky_phone. Validate every returned success value and keep money, permissions, ownership, and other authoritative changes on the server.

Client Exports

Client Exports

Server Exports

Server Exports

Billing Exports

Billing Exports

CrewLink Exports

CrewLink Exports

Trusted Adapter Exports

Exports ending in FromAdapter are reserved for resources explicitly listed in Config.CustomApps.TrustedAdapters. Normal custom apps must use the owner-bound exports above.

Runtime	Export	Signature
Client	`AddCustomAppFromAdapter`	`(ownerResource, definition)`
Client	`UpdateCustomAppFromAdapter`	`(ownerResource, definition)`
Client	`RemoveCustomAppFromAdapter`	`(ownerResource, appId)`
Client	`OpenCustomAppFromAdapter`	`(ownerResource, appId, data?)`
Client	`CloseCustomAppFromAdapter`	`(ownerResource, appId)`
Client	`CloseActiveCustomAppFromAdapter`	`(ownerResource)`
Client	`SendCustomAppMessageFromAdapter`	`(ownerResource, appId, payload)`
Client	`SendCustomAppNotificationFromAdapter`	`(ownerResource, appId, notification)`
Server	`AddCustomAppPolicyFromAdapter`	`(ownerResource, definition)`
Server	`UpdateCustomAppPolicyFromAdapter`	`(ownerResource, definition)`
Server	`RemoveCustomAppPolicyFromAdapter`	`(ownerResource, appId)`

client.lua

-- Trusted adapter example only. Normal apps must not use this export.
local registered, error_code = exports["sky_phone"]:AddCustomAppFromAdapter(
    "legacy_dispatch",
    converted_definition
)

The adapter resource remains responsible for mapping the external contract and preserving the real owner resource.

Compatibility Aliases

Free Phone exposes a documented subset of common third-party phone contracts:

Resource alias	Supported client exports
`lb-phone`	`AddCustomApp`, `RemoveCustomApp`, `SendCustomAppMessage`, `OpenApp`, `CloseApp`, `SendNotification`
`17mov_Phone`	`AddApplication`, `RemoveApplication`, `SendAppMessage`
`high-phone`	`addApplication`, `sendAppNui`
`qs-smartphone`	`addCustomApp`, `addCustomAppsBatch`, `updateCustomApp`, `removeCustomApp`, `getCustomApps`, `OpenPhoneApp`
`yseries`	`AddCustomApp`, `RemoveCustomApp`, `SendAppMessage`, `CloseApp`, `GetDataLoaded`

Compatibility is contract-based and does not emulate every feature of the original phone.

Features

Explore the device system, built-in apps, media, social features, integrations, and developer platform included with Free Phone.

Client Exports

Client Exports for the Free Phone custom-app, billing and CrewLink integrations.