ApiInterfaceProps | @aardvarkxr/aardvark-react

Index

apiName: string

Name of the API implemented by this object. This must be in the form @.

handlers: {}

Message type handlers for incoming messages. If an incoming message is received of a type that is not present in this list, it will be discarded.

The handler for each message type must return the parameters that it wants to reply to the sender with. If

implementation: boolean

If this is true, this object is the singleton implementation of the interface.

onConnect: (peer: EndpointAddr) => void

Called when the API interface connects.

onDisconnect: (peer: EndpointAddr) => void

Called when the API interface disconnects.