iOS SDK 1.0.0 API Coverage Matrix
SDK Version: 1.0.0
Platform: iOS
This matrix audits the formal customer-facing Swift declarations symbol by symbol. Recommended is the normal customer path. Advanced is for custom transport or protocol developers. Unlisted implementation details are outside the compatibility contract.
Product inventory
| Product | Public entry point | Detailed guide |
|---|---|---|
Mesh | MeshSdk | Mesh SDK |
Low Latency PTT | LowLatencyPttSdk | Low Latency PTT SDK |
BLE | XTalkBleClient | BLE Connection SDK |
Device Auth | XTalkDeviceAuthenticator | Device Authentication SDK |
File/Image Transfer | XTalkFileTransferManager / XTalkImageTranscoder | File and Image Transfer SDK |
OTA | XTalkTurMassOtaManager / XTalkBluetoothFotaManager | OTA SDK |
| Identifier | Product | Level | Details/example |
|---|---|---|---|
XTalkScanResult | BLE | Recommended | Scan model |
XTalkConnectionState | BLE | Recommended | Connection state |
XTalkBleError | BLE | Recommended | Errors |
XTalkAtEncoding | BLE | Advanced | AT models |
XTalkAtResponseMode | BLE | Advanced | AT models |
XTalkDiMeta | BLE | Recommended | Event metadata |
XTalkBleEvent | BLE | Recommended | Events |
XTalkBleClient.init | BLE | Recommended | Lifecycle |
XTalkBleClient.connectionState/scanResults | BLE | Recommended | State |
XTalkBleClient.connectedName/connectedAddress/connectedPeripheralId | BLE | Recommended | State |
XTalkBleClient.atReady/deviceControlReady/atEncoding | BLE | Recommended | Readiness |
XTalkBleClient.events/onEvent | BLE | Recommended | Events |
XTalkBleClient.startScan/stopScan | BLE | Recommended | Scanning |
XTalkBleClient.connect/disconnect/teardown | BLE | Recommended | Lifecycle |
XTalkBleClient.setAtEncoding | BLE | Advanced | AT methods |
XTalkBleClient.runAtCommand | BLE | Recommended | AT methods |
XTalkBleClient.sendAtCommandNoWait | BLE | Advanced | No-wait |
XTalkBleClient.withExclusiveAtSession | BLE | Advanced | Transactions |
XTalkBleClient.sendRfPayload | BLE | Recommended | RF method |
XTalkBleClient.sendRfPayloadNoWait | BLE | Advanced | RF no-wait |
XTalkBleClient.fetchBatteryLevel | BLE | Recommended | Device info |
XTalkBleClient.fetchBleFirmwareVersion | BLE | Recommended | Device info |
XTalkBleClient.fetchHardwareVersion | BLE | Recommended | Device info |
XTalkBleClient.observeAtLines/removeAtLineObserver | BLE | Advanced | Observers |
XTalkBleClient.observeSendFinishLines/removeSendFinishLineObserver | BLE | Advanced | Observers |
XTalkBleClient.observePassthroughRaw/removePassthroughRawObserver | BLE | Advanced | Observers |
DeviceAuthAtEncoding | Auth | Advanced | Transport models |
DeviceAuthResponseMode | Auth | Advanced | Transport models |
DeviceAuthTransport.label/atEncoding | Auth | Advanced | Transport contract |
DeviceAuthTransport.setAtEncoding/runAtCommand | Auth | Advanced | Adapter |
XTalkDeviceAuthConfiguration | Auth | Recommended | Configuration |
XTalkDeviceAuthResult | Auth | Recommended | Result |
XTalkDeviceAuthState | Auth | Recommended | State |
XTalkDeviceAuthError | Auth | Recommended | Auth errors |
XTalkDeviceAuthenticator.init | Auth | Recommended | Authenticate |
XTalkDeviceAuthenticator.state | Auth | Recommended | State |
XTalkDeviceAuthenticator.authenticate | Auth | Recommended | Authenticate |
XTalkDeviceAuthenticator.cancel | Auth | Recommended | Cancellation |
XTalkDeviceIdentitySource | Auth | Recommended | Identity |
XTalkDeviceIdentity | Auth | Recommended | Identity |
XTalkDeviceIDCodec.canonicalize | Auth | Advanced | DID utilities |
XTalkDeviceIDCodec.fromSn | Auth | Advanced | DID utilities |
XTalkDeviceIDCodec.parse | Auth | Recommended | DID utilities |
XTalkDeviceIDCodec.format | Auth | Recommended | DID utilities |
MeshSdk.Config/Transport/LearnedRouteStore | Mesh | Advanced | API |
MeshSdk.events/handleInbound | Mesh | Recommended | Inbound data |
MeshSdk.sendPublicText | Mesh | Recommended | Public text |
MeshSdk.sendPublicVoiceAiCodecFrames | Mesh | Recommended | Public voice |
MeshSdk.sendRepairablePublicVoiceAiCodecFrames/sendPublicVoiceRepairAck | Mesh | Advanced | Repairable voice |
MeshSdk.discoverNearbyMapUsers | Mesh | Recommended | Nearby users |
MeshSdk.sendMapFriendRequest/sendMapFriendAck | Mesh | Recommended | Friends |
MeshSdk.sendFriendDirectText/sendFriendDirectAck | Mesh | Recommended | Direct text |
MeshSdk.sendMapLocShareRequest/sendMapLocShareAck | Mesh | Recommended | Location authorization |
MeshSdk.sendMapLocHeartbeatBroadcast/sendMapLocStopBroadcast | Mesh | Recommended | Location sharing |
MeshSdk.sendMapGroupAddMembersRequest/sendMapGroupAddMembersAck | Mesh | Recommended | Group membership |
MeshSdk.sendMapGroupJoinNoticeBroadcast/sendMapGroupRosterSyncBroadcast | Mesh | Recommended | Group synchronization |
MeshSdk.sendTraceRoute/learnedRouteSnapshot | Mesh | Advanced | Routes |
MeshSdk.updateNodeId/updateRateMode/updateMaxRfPayloadBytes/updateDefaultHopLimit | Mesh | Advanced | Runtime configuration |
AiTalkMeshRadioProfile/MeshPairingPsk | Mesh | Advanced | Protocol profile |
LowLatencyPttSdk | Low Latency PTT | Recommended | Complete API |
LowLatencyPttSdk.enable/disable/startTalking/stopTalking/close | Low Latency PTT | Recommended | Lifecycle |
LowLatencyPttSdk.setChannel/setRateMode/setAvailableGroups/setGroup | Low Latency PTT | Recommended | Runtime configuration |
LowLatencyPttSdk.snapshot/events/tryHandleInbound | Low Latency PTT | Recommended | State and events |
LowLatencyPttTransport/LowLatencyPttTransportSession | Low Latency PTT | Advanced | Transport contract |
LowLatencyPttConfiguration/LowLatencyPttGroupProfile | Low Latency PTT | Recommended | Configuration |
XTalkFileTransferManager | File/Image Transfer | Recommended | File transfer entry |
FileTransferTransport/FileTransferRadioLease | File/Image Transfer | Advanced | Transport contract |
XTalkImageTranscoder/XTalkImageTranscodeOptions/XTalkTranscodedImage | File/Image Transfer | Recommended | Image transcoding |
XTalkTurMassOtaManager/XTalkBluetoothFotaManager | OTA | Recommended | Upgrade entry |
XTalkOtaFirmwareCatalog/XTalkOtaFirmwareDescriptor | OTA | Recommended | Firmware catalog |
XTalkOtaTarget/XTalkOtaState/XTalkOtaOptions/XTalkOtaResult/XTalkOtaError | OTA | Recommended | State and errors |