Skip to main content
API Reference NSDK NSDKVps2Session

anchorPayload

Gets the payload data of a specified anchor....

Declaration

func anchorPayload(anchorId: NSDKVpsAnchorId) -> NSDKAsyncState<String, Never>?

Summary

Gets the payload data of a specified anchor.
The payload encodes the data needed to relocalize an anchor across devices or sessions.
It can be stored and used later with trackAnchor(payload:).
For anchors created via createAnchor(at:), subscribe to createdAnchorPayload
instead of polling this method — the session handles polling automatically.
- Precondition: anchorId must be exactly 32 characters long.
- Parameter anchorId: The unique identifier of the anchor.
- Returns:
- .inProgress(nil): The anchor is tracked but the payload is not yet available.
- .success(payload): The base64-encoded payload is ready.
- nil: No anchor with anchorId was found.