Exports & events

With a source, returns the number of the player's phone session. If there is no session, it checks that the player carries a phone and reads its number from rarx_phone_numbers (it never creates one). Returns nil if the player has no phone on them or is offline.

With a string (citizenid), it uses the player if they are online and otherwise reads the database, like LB.

Returns the server id of the online player who owns that number, or false.

Same behaviour as LB:

• If target is a player id (source), the notification is transient: it shows, plays a sound and is not stored.
• If target is a phone number (string) and data.app is set, it is stored in rarx_phone_notifications and delivered instantly if the owner is online.

Accepted fields: app, title, content (or description), thumbnail, avatar, showAvatar, icon, customData (or data) and actions. Content is cut at 500 characters. cb(value) receives the same value that is returned.

exports['lb-phone']:SendNotification('551234', { app = 'alertadefcon', title = 'DEFCON 3', content = 'Moderate alert' })
exports.rarx_phone:SendNotification(source, { app = 'Messages', title = 'Dispatch', content = 'Unit on the way' })

Transient notification flagged critical = true, with icon = 'warning' and the app set in Config.Compat.EmergencyApp. Like LB it is per player; to reach everyone, loop over GetPlayers() or use NotifyEveryone.

SendAmberAlert is an alias with the same arguments and behaviour.

'online' only shows it to connected players. 'all' also stores it for everyone who has a phone number.

Returns the number formatted with Config.PhoneNumber.Format.

Returns the character's number, creating one if they do not have any.

Returns the number of the player's open phone session, or nil.

Sends a system message to that number.

Pushes data to a home screen widget of that player.

Number-to-number message. If the sender does not belong to any player (an NPC, a dispatch line), the message is still created with that number as sender.

• attachments is a list of URLs (or tables with url). Only hosts allowed in Config.Messages.MediaHosts are accepted.
• With attachments the message is an image message (or a video message if all are videos) and the text becomes the caption.
• The recipient must have a rarx_phone number.
• LB's sixth argument (channelId) is ignored: only direct messages are supported.

exports['lb-phone']:SendMessage('900200', '551234', 'Meet me at the docks.', { 'https://r2.fivemanage.com/x.jpg' })

to can be an address ([email protected]), 'all' (every account), a source, a phone number or a citizenid. The recipient needs a mail account. sender is free text ('Car Dealer').

Buttons use the same format as LB, including data.qbMail:

actions = { { label = 'Accept', data = { event = 'my_resource:accept', isServer = true, data = { id = 4 } } } }

Buttons are stored in the actions column (migration 053_mail_actions.sql, applied automatically on start). Without that migration the mail is sent without buttons.

When the player presses a button, the server checks that the mail belongs to them and sends the action to their client, which runs TriggerServerEvent(event, mailId, data) if isServer, or TriggerEvent(event, mailId, data) otherwise, like LB.

exports['lb-phone']:SendMail({
    to = exports['lb-phone']:GetEmailAddress(source),
    sender = 'Premium Dealership',
    subject = 'Your car is ready',
    message = 'Come and pick it up.',
    actions = { { label = 'Set route', data = { event = 'dealership:route', isServer = false } } },
})

Returns the character's mail address, or nil.

Removes the PIN and face unlock of the owner of that number (including the face enrollments of their phones) and clears the failed-attempts lock. If the owner is online, their session is unlocked and the phone closes so it starts again without PIN. Also accepts a source.

Does the same as ResetSecurity, also wipes the settings and shows the setup wizard again. It does not delete messages, photos, notes or mail (LB does not either). If the owner is online, the phone is dropped and factoryReset and numberChanged are fired.

Changes the password of a phone account. The matching admin command (default /changepassword) accepts birdy, twitter, rrx, instagram, instapic, tiktok, trendy, mail and darkchat. Returns false if the account is not found.

event can be any rarx RPC method ('calls:start', 'messages:send', 'bank:transfer', 'mail:send'...), '*' (all of them) or an LB name from Config.Compat.LbChecks. If the function returns false, the action is rejected with err_app_blocked.

The function always receives (source, params, method), not the individual arguments of each LB event. A check that throws an error is logged in the console and does not block. Checks are removed automatically when the resource that added them stops.

exports['lb-phone']:AddCheck('calls:start', function(source)
    return not Player(source).state.isHandcuffed
end)

Removes a check added with AddCheck.

Whether the player is in a call.

Whether the player carries a phone.

With the player online it reads their session; otherwise their saved settings.

Server-side version of the client ToggleDisabled: closes the player's phone and prevents opening it while disabled is true.

Sets the verified badge. app accepts the LB names: 'Twitter' / 'Birdy' map to Birdy accounts; 'Instagram', 'InstaPic', 'TikTok', 'Trendy' and 'rrx' map to RRX accounts (which also hold clips). username with or without @.

When verifying, the owner gets a notification, toggleVerified is fired and the action is written to the admin log. Returns false if the account does not exist or the app is not a social app.

Reads the verified badge, with the same app names as ToggleVerified.

Username of the account used by the owner of that number: on Birdy the account of the active session (or the first one), on RRX their account. With app = 'Mail' it returns the mail address.

caller is { source = id }, a source or the number of an online player. callee is a number or an emergency service ('police', '112'... from Config.Calls.Emergency); if missing, options.company is used.

It opens the caller's phone and dials from their screen, so it goes through the same checks as a normal call (airplane mode, coverage, busy, checks). Options: videoCall, requirePhone. hideNumber is not applied: the player's own "Hide my number" setting decides.

It waits up to 8 seconds for the call to start and returns its callId (or nil). Call it from a thread (CreateThread or an event handler).

CreateThread(function()
    local id = exports['lb-phone']:CreateCall({ source = source }, '552222')
end)

Hangs up (or rejects, if it is ringing) the player's call through the same path as the red button.

Returns the call table, the same one received by newCall and callEnded.

Returns the current call of that player and its call table.

Adds an entry to the history of the phone's Bank app (rarx_phone_bank_log). It does not change the balance: money is handled by your framework. Negative amount is a payment, positive is income. company is the description (cut at 50 characters).

The owner sees it immediately if the Bank app is open, together with a Bank notification (logo as thumbnail). Fires onAddTransaction and is written to the money log.

exports['lb-phone']:AddTransaction('551234', -250, 'Ron Gas Station')
exports['lb-phone']:ToggleVerified('Birdy', 'lspd', true)

Removes PIN and face unlock from the phone of the player with that server id. The action is written to the Discord log. The name is configurable in Config.Compat.ResetCommand.

Sets or removes the verified badge. app: birdy, lenz, rrx, twitter, instagram, tiktok, trendy, instapic. 1 (default) verifies, 0 removes, 2 gives the gold badge (Birdy only). The name is configurable in Config.Compat.VerifyCommand.

Changes the password of a phone account and closes its open sessions. app: birdy, twitter, rrx, instagram, instapic, tiktok, trendy, mail, darkchat. The name is configurable in Config.Compat.PasswordCommand.

Opens (true) or closes (false) the phone. Without arguments it toggles.

Closes the phone and prevents opening it while disabled is true. Can also be called from the server with exports.rarx_phone:ToggleDisabled(source, true).

If fn returns false, the phone does not open. Remove it with RemoveCheck(id). Checks are removed automatically when the resource that added them stops.

Saves the URL to the player's Gallery through the same path as the app: allowed hosts, photo limit, no duplicates. The player must carry the phone.

Sets the battery level. Does nothing if the battery system is disabled, like LB.

Forces charging on or off. Applied on the next check (at most 3 seconds). false does not stop charging if the player is standing next to a charger placed from the panel.

Kept for older items configured with export = 'lb-phone.UsePhoneItem'.

Opens the phone if needed and then the app. The name goes through Config.Compat.AppNames ('Wallet' becomes bank, 'Birdy' becomes birdy...); names not in the table are used as-is (custom apps). metadata reaches the app as open parameters. An app that does not exist or is disabled is not opened.

Without app it goes back to the home screen. With closeCompletely the app is also removed from recents.

Opens the phone and dials from the screen, as if the player had pressed call. Does nothing if the player is already in a call.

Forces the coverage bars to a value from 0 to 4. false or nil returns to automatic coverage.

Arguments: call. A call starts ringing.

Arguments: call, plus the source of the player who answered (rarx only). The call is answered.

Arguments: call, source. The call ends: hung up, rejected, unanswered, disconnect or maximum duration.

Arguments: { channelId, messageId, sender, recipient, message, attachments, type?, source? }. A message is sent from the app or with SendMessage. In groups recipient is nil.

Arguments: { id?, to, sender, subject, message, attachments, actions, read, timestamp, source? }. A mail is sent from the app or with SendMail.

Arguments: source, number (or nil after a reset). An admin changes or approves a number, or FactoryReset runs.

Arguments: source, number. FactoryReset runs with the player online.

Arguments: source | nil, number. ResetSecurity or the reset command runs.

Arguments: kind, data. Fired for several apps; the LB events receive only the data table.

Arguments: room, alias, content, plus source (rarx only). A message is posted in DarkChat.

Arguments: { id, accountId, username, content, media, replyTo, quoteOf }. A post or reply is published on Birdy.

Arguments: app, username, verified. rarx passes 'birdy' or 'rrx'; the LB event passes the app name that was received.

Arguments: 'received' | 'paid', number, amount, description, logo. Fired by AddTransaction.

Arguments: source, settings. The player saves their settings.

Arguments: source, identifier, action, data. See External apps API.

Arguments: open. The phone is opened or closed.

Arguments: number | nil. Number change or reset.

No arguments. The battery reaches 0.

Arguments: settings. The player changes a setting (fired after it is saved on the server).

Arguments: identifier, action, data. See External apps API.

Registers a service number. On failure reason is numero (invalid number) or ocupado (another resource already owns it).

Removes a service number. Only the resource that registered it can remove it.

Sends a message from the service number. target can be an online source or a phone number; the chat is created like any other conversation and the player can reply. image must be a URL from Config.Messages.MediaHosts.

Says a line in an active service call and optionally replaces the current menu.

Hangs up a service call.

Returns { { number, name, avatar, resource } }.