ca.mint.mintchip.contract

Interface IValueRequestMessage

All Superinterfaces:
IMessage

public interface IValueRequestMessage extends IMessage

This interface represents a request for a Value Message.

Methods
Modifier and Type Method and Description
int getAmount()
Gets the amount.
java.lang.String getAnnotation()
Gets the annotation.
int getChallenge()
Gets the challenge.
CurrencyCode getCurrencyCode()
Gets the currency code.
java.lang.String getPayeeId()
Gets the payee id.
java.lang.String getResponseAddress()
Gets the response address.
void setAmount(int amount)
Sets the amount.
void setAnnotation(java.lang.String annotation)
Sets the annotation.
void setChallenge(int challenge)
Sets the challenge.
void setCurrencyCode(CurrencyCode currencyCode)
Sets the currency code.
void setPayeeId(java.lang.String payeeId)
Sets the payee id.
void setResponseAddress(java.lang.String responseAddress)
Sets the response address.
Methods inherited from interface ca.mint.mintchip.contract.IMessage
toBase64String
Method Detail

getAmount

int getAmount()

Gets the amount.

Returns:
the amount or value requested

setAmount

void setAmount(int amount)

Sets the amount.

Parameters:
amount - sets the amount or value requested

getCurrencyCode

CurrencyCode getCurrencyCode()

Gets the currency code.

Returns:
the currency of the requested value

setCurrencyCode

void setCurrencyCode(CurrencyCode currencyCode)

Sets the currency code.

Parameters:
currencyCode - sets the currency of the requested value

getPayeeId

java.lang.String getPayeeId()

Gets the payee id.

Returns:
the MintChip Id of the intended recipient of the requested Value Message

setPayeeId

void setPayeeId(java.lang.String payeeId)

Sets the payee id.

Parameters:
payeeId - sets the MintChip Id of the intended recipient of the requested Value Message

getAnnotation

java.lang.String getAnnotation()

Gets the annotation.

Returns:
a textual description to be associated with the requested Value Message.
This is an optional property.

setAnnotation

void setAnnotation(java.lang.String annotation)

Sets the annotation.

Parameters:
annotation - sets a textual description to be associated with the requested Value Message.
This is an optional property.

getChallenge

int getChallenge()

Gets the challenge.

Returns:
the challenge, a nounce to assert freshness of a Value Message.
This is an optional property. If the challenge is not set in the request it will be auto-generated by the MintChip.

setChallenge

void setChallenge(int challenge)

Sets the challenge.

Parameters:
challenge - sets the challenge, a nounce to assert freshness of a Value Message.
This is an optional property. If the challenge is not set in the request it will be auto-generated by the MintChip.

getResponseAddress

java.lang.String getResponseAddress()

Gets the response address.

Returns:
an address where the response to this request should be sent to.
This is an optional property.

setResponseAddress

void setResponseAddress(java.lang.String responseAddress)

Sets the response address.

Parameters:
responseAddress - sets the address where the response to this request should be sent to.
This is an optional property.