> ## Documentation Index
> Fetch the complete documentation index at: https://mythicframework.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
# Phone - Exports
> Phone component API for notifications, data management, and UI control
The Phone component provides server-side notification delivery and client-side UI control. Other resources interact with the phone primarily through notifications and data updates.
## Overview
Access via `Phone` on both server and client.
Push notifications to players
Manage app data
Open, close, and manage phone state
App-level permission checks
***
## Server-Side Methods
**Primary Server API:** The main way other resources interact with the phone server-side is through `Phone.Notification`. Direct data manipulation should be rare.
### Phone.Notification:Add
Send a notification to a player's phone.
```lua theme={null}
Phone.Notification:Add(source, title, description, time, duration, app, actions, notifData)
```
Player server ID
Notification title
Notification body text
Timestamp (use `os.time()`)
Display duration in milliseconds
App identifier (e.g., `'messages'`, `'email'`, `'bank'`)
Action buttons on the notification
Additional data payload
**Example:**
```lua theme={null}
-- Simple notification
Phone.Notification:Add(source, 'New Message', 'You have a new text message', os.time(), 5000, 'messages')
-- Notification with data
Phone.Notification:Add(source, 'Bank Alert', 'Deposit of $5,000 received', os.time(), 5000, 'bank', nil, {
amount = 5000,
account = accountNumber
})
-- 911 dispatch notification to police
local dutyData = Jobs.Duty:GetDutyData('police')
for _, policeSource in ipairs(dutyData.DutyPlayers) do
Phone.Notification:Add(policeSource, '911 Call', 'Shots fired at Legion Square', os.time(), 10000, 'phone')
end
```
***
### Phone.Notification:AddWithId
Send a notification with a specific ID for tracking and updating.
```lua theme={null}
Phone.Notification:AddWithId(source, id, title, description, time, duration, app, actions, notifData)
```
Unique notification identifier for later updates/removal
All other parameters are the same as `Notification:Add`.
**Example:**
```lua theme={null}
-- Trackable notification
Phone.Notification:AddWithId(source, 'delivery_123', 'Delivery Update', 'Your package is on the way', os.time(), 8000, 'email')
```
***
### Phone.Notification:Update
Update an existing notification by ID.
```lua theme={null}
Phone.Notification:Update(source, id, title, description)
```
Player server ID
Notification ID (from AddWithId)
New title
New description
**Example:**
```lua theme={null}
-- Update delivery status
Phone.Notification:Update(source, 'delivery_123', 'Delivery Complete', 'Your package has been delivered')
```
***
### Phone.Notification:RemoveById
Remove a notification by its ID.
```lua theme={null}
Phone.Notification:RemoveById(source, id)
```
***
### Phone:UpdateJobData
Update a player's job data on their phone (permissions, apps, etc.).
```lua theme={null}
Phone:UpdateJobData(source, returnValues)
```
Player server ID
If `true`, returns the data instead of sending to client
When `returnValues` is true: `{charJobPerms = table, jobData = table}`
***
## Client-Side Methods
### Phone:Open
Opens the phone UI.
```lua theme={null}
Phone:Open()
```
***
### Phone:Close
Closes the phone UI.
```lua theme={null}
Phone:Close(forced, doJankyStuff)
```
Force close, skip route reset
Skip route reset behavior
***
### Phone:IsOpen
Check if the phone UI is currently open.
```lua theme={null}
Phone:IsOpen()
```
`true` if phone is open
**Example:**
```lua theme={null}
-- Close phone before starting an action
if Phone:IsOpen() then
Phone:Close()
end
```
***
### Phone:OpenLimited
Opens the phone in limited mode (e.g., for payphones).
```lua theme={null}
Phone:OpenLimited()
```
***
### Phone:OpenPayphone
Opens the phone specifically for payphone use.
```lua theme={null}
Phone:OpenPayphone()
```
***
### Phone:IsAppUsable
Check if a specific app is installed and usable by the current player.
```lua theme={null}
Phone:IsAppUsable(app)
```
App identifier or table of app identifiers
`true` if the app is accessible
***
## Phone Data Methods (Client)
### Phone.Data:Set
Set phone data by key.
```lua theme={null}
Phone.Data:Set(key, data)
```
***
### Phone.Data:Add
Add data to the phone store.
```lua theme={null}
Phone.Data:Add(type, data, key)
```
***
### Phone.Data:Update
Update existing phone data.
```lua theme={null}
Phone.Data:Update(type, id, data)
```
***
### Phone.Data:Remove
Remove phone data by key and ID.
```lua theme={null}
Phone.Data:Remove(key, id)
```
***
### Phone.Data:Reset
Clear all phone data.
```lua theme={null}
Phone.Data:Reset()
```
***
## Permissions (Client)
### Phone.Permissions:HasPermission
Check if the current player has a specific app permission.
```lua theme={null}
Phone.Permissions:HasPermission(app, permission)
```
App identifier
Permission name
`true` if player has the permission
**Example:**
```lua theme={null}
-- Check if player can create redline races
if Phone.Permissions:HasPermission('redline', 'create') then
-- Allow race creation
end
```
***
## Best Practices
```lua theme={null}
-- ✅ Good: Important notifications stay longer
Phone.Notification:Add(source, '911 Call', 'Emergency at ...', os.time(), 10000, 'phone')
-- ✅ Good: Info notifications are shorter
Phone.Notification:Add(source, 'Bank', 'Deposit received', os.time(), 3000, 'bank')
```
```lua theme={null}
-- Use AddWithId when you need to update or remove later
Phone.Notification:AddWithId(source, 'taxi_' .. requestId, 'Taxi Request', 'Picking up...', os.time(), 0, 'phone')
-- Later, update it
Phone.Notification:Update(source, 'taxi_' .. requestId, 'Taxi', 'Arrived at pickup')
-- Or remove it
Phone.Notification:RemoveById(source, 'taxi_' .. requestId)
```
***
## Next Steps
Phone events and middleware
App configuration and restrictions
Character data access