Skip to main content

Solidity API

ILockTokenURIHook

Functions to be implemented by a tokenURIHook.

Lock hooks are configured by calling setEventHooks on the lock.

tokenURI

function tokenURI(address lockAddress, address operator, address owner, uint256 keyId, uint256 expirationTimestamp) external view returns (string)

If the lock owner has registered an implementer then this hook is called every time tokenURI() is called

Parameters

NameTypeDescription
lockAddressaddressthe address of the lock
operatoraddressthe msg.sender issuing the call
owneraddressthe owner of the key for which we are retrieving the tokenUri
keyIduint256the id (tokenId) of the key (if applicable)
expirationTimestampuint256the key expiration timestamp

Return Values

NameTypeDescription
[0]stringthe tokenURI