SecretNET.NFT Namespace

Snip721Querier..::..GetNftDossier Method

NftDossier returns all the information about a token that the viewer is permitted to view. If no viewer is provided, NftDossier will only display the information that has been made public. The response may include the owner, the public metadata, the private metadata, the reason the private metadata is not viewable, the royalty information, the mint run information, whether the token is transferable, whether ownership is public, whether the private metadata is public, and (if the querier is the owner,) the approvals for this token as well as the inventory-wide approvals for the owner. This implementation will only display a token's royalty recipient addresses if the querier has permission to transfer the token. SNIP-722 adds a transferable field to the NftDossier response. SNIP-723 (specification to be written) adds an unwrapped field which is false if private metadata for this token is sealed.

Namespace:  SecretNET.NFT
Assembly:  SecretNET.NFT (in SecretNET.NFT.dll)

Syntax


public Task<SecretQueryContractResult<GetNftDossierResponse>> GetNftDossier(
	string contractAddress,
	string tokenId,
	ViewerInfo viewerInfo,
	Nullable<Permit> permit,
	Nullable<bool> includeExpired,
	Nullable<string> codeHash
)
Public Function GetNftDossier ( _
	contractAddress As String, _
	tokenId As String, _
	viewerInfo As ViewerInfo, _
	permit As Nullable(Of Permit), _
	includeExpired As Nullable(Of Boolean), _
	codeHash As Nullable(Of String) _
) As Task(Of SecretQueryContractResult(Of GetNftDossierResponse))
public:
Task<SecretQueryContractResult<GetNftDossierResponse^>^>^ GetNftDossier(
	String^ contractAddress, 
	String^ tokenId, 
	ViewerInfo^ viewerInfo, 
	Nullable<Permit^> permit, 
	Nullable<bool^> includeExpired, 
	Nullable<String^> codeHash
)

Parameters

contractAddress
Type: String
The contract address.
tokenId
Type: String
The IDs of the token being queried.
viewerInfo
Type: SecretNET.NFT..::..ViewerInfo
The address and viewing key performing this query.
permit
Type: Nullable<(Of <(<'Permit>)>)>
Authenticate with permit.
includeExpired
Type: Nullable<(Of <(<'Boolean>)>)>
True if expired transfer approvals should be included in the response.
codeHash
Type: Nullable<(Of <(<'String>)>)>
CodeHash is (not really) optional and makes a call way faster.

Return Value

SecretQueryContractResult<GetNftDossierResponse>.