One Logo Pool Ball
X
Github
Discord

System

RealityFoundation · IOS API REFERENCE

SynchronizationEvents.OwnershipRequest

struct · iOS 13.0+ · SDK 27.1

struct OwnershipRequest

The event raised when a network peer wants to gain ownership of an entity.

Members (3)

get · iOS 13.0+

accept

TypeScript
get accept(): (() => Promise<void>)
Swift declaration
let accept: () -> Void

The callback function that the current owner calls to grant ownership to the requesting peer. If an entity’s ``SynchronizationComponent/ownershipTransferMode-swift.property`` property is set to ``SynchronizationComponent/OwnershipTransferMode-swift.enum/autoAccept``, the entity automatically grants ownership to any other entity that requests it. In case you configure an entity to have a transfer mode of ``SynchronizationComponent/OwnershipTransferMode-swift.enum/manual``, then when you receive an ``SynchronizationEvents/OwnershipRequest`` event, call the ``SynchronizationEvents/OwnershipRequest/accept`` method to complete the transfer of ownership.

get · iOS 13.0+

entity

TypeScript
get entity(): Entity
Swift declaration
let entity: Entity

The entity over which the network peer would like to gain ownership.

get · iOS 13.0+

requester

TypeScript
get requester(): SDKHandle
Swift declaration
let requester: any SynchronizationPeerID

The network peer requesting ownership.

Skipped declarations

No declarations were skipped in this snapshot.

All RealityFoundation types →