io.nem.symbol.sdk.api

Interface MosaicRestrictionTransactionService

All Known Implementing Classes:

MosaicRestrictionTransactionServiceImpl

public interface MosaicRestrictionTransactionService

Service that helps clients setting up and updating mosaic restrictions.

Method Summary

Modifier and Type	Method and Description
io.reactivex.Observable<MosaicAddressRestrictionTransactionFactory>	createMosaicAddressRestrictionTransactionFactory(UnresolvedMosaicId mosaicId, java.math.BigInteger restrictionKey, UnresolvedAddress targetAddress, java.math.BigInteger restrictionValue) Create a MosaicAddressRestrictionTransactionFactory object that can be used to create or update a mosaic address restriction.
io.reactivex.Observable<MosaicGlobalRestrictionTransactionFactory>	createMosaicGlobalRestrictionTransactionFactory(UnresolvedMosaicId mosaicId, java.math.BigInteger restrictionKey, java.math.BigInteger restrictionValue, MosaicRestrictionType restrictionType) Create a MosaicGlobalRestrictionTransactionFactory object that can be used to create or update a mosaic global restriction.

Method Detail

createMosaicGlobalRestrictionTransactionFactory

io.reactivex.Observable<MosaicGlobalRestrictionTransactionFactory> createMosaicGlobalRestrictionTransactionFactory(UnresolvedMosaicId mosaicId,
                                                                                                                   java.math.BigInteger restrictionKey,
                                                                                                                   java.math.BigInteger restrictionValue,
                                                                                                                   MosaicRestrictionType restrictionType)

Create a MosaicGlobalRestrictionTransactionFactory object that can be used to create or update a mosaic global restriction.

This service checks the current global restriction value using rest and set the corresponding previousRestrictionType and previousRestrictionValue so an update can be performed.

When using aliases, the service will resolve them in order to query the mosaic restriction rest endpoint. This could add some overhead. If you know the real mosaic id, it's recommended to use it.

Parameters:

mosaicId - the mosaic id or an alias. If an alias is sent, the service will resolve it in order to retrieve the current global restriction value.

restrictionKey - Restriction key

restrictionValue - New restriction value

restrictionType - New restriction type

Returns:

MosaicGlobalRestrictionTransactionFactory of the transaction ready to be announced.

createMosaicAddressRestrictionTransactionFactory

io.reactivex.Observable<MosaicAddressRestrictionTransactionFactory> createMosaicAddressRestrictionTransactionFactory(UnresolvedMosaicId mosaicId,
                                                                                                                     java.math.BigInteger restrictionKey,
                                                                                                                     UnresolvedAddress targetAddress,
                                                                                                                     java.math.BigInteger restrictionValue)

Create a MosaicAddressRestrictionTransactionFactory object that can be used to create or update a mosaic address restriction.

This service checks the current address restriction value using rest and set the corresponding previousRestrictionValue so an update can be performed.

When using aliases, the service will resolve them in order to query the mosaic restriction rest endpoint. This could add some overhead. If you know the real mosaic id and target address, it's recommended to use them.

Parameters:

mosaicId - the mosaic id or an alias. If an alias is sent, the service will resolve it * in order to retrieve the current mosaic address restriction value.

restrictionKey - Restriction key

targetAddress - the target address or an alias. If an alias is sent, the service will resolve it in order to retrieve the current mosaic address restriction value.

restrictionValue - New restriction value

Returns:

MosaicAddressRestrictionTransactionFactory object without previous restriction data