Swift SDK API reference
At launchThe complete, auto-generated reference for every public symbol in YdentifiDeviceSDK — each type, method, parameter, and error — rendered from the source with DocC. It is the exhaustive companion to the Swift SDK guide, and it publishes with the package on the Swift Package Index.
Who this is for: anyone who needs the exact signature. The guide page teaches the flow; this is the lookup. Because it is generated from source, it never drifts from the code you compile against.
This is the exhaustive, auto-generated companion to the Swift SDK guide. The guide teaches the flow; this reference is the exact-signature lookup for every public symbol. It publishes with the package.
What will be here#
The complete public surface of YdentifiDeviceSDK, one page per type and method, grouped as its DocC catalog already is:
YdentifiDeviceYdentifiTransportYdentifiTransportConfigYdentifiEndpointSPKIPinningYdentifiAppVersionMTLSIdentityKeyringSecureEnclaveKeyringInMemoryKeyringEnrollmentChallengeEnrolledDeviceDevicePlatformFetchedChallengeAuthChallengeExpressionChallengeOutcomeAckChallengeNotificationLocationConstraintLocationResultDeclineReasonYdentifiDeviceErrorServerErrorReasonPlus the narrative articles the catalog ships with today: Enrolling a device, Responding to authentication challenges, Error handling, and the Security model.
Generated from source#
The reference is not hand-written. It is rendered straight from the SDK’s doc-comments with Apple’s DocC, so it cannot drift from the code that ships:
$ swift package generate-documentation --target YdentifiDeviceSDKAt launch it is hosted alongside the package on the Swift Package Index, and re-generated on every release — the same doc-comments Xcode shows on ⌥-click in your own project.