ABCReceiveAddress Class Reference

Inherits from NSObject
Declared in ABCReceiveAddress.h

Overview

ABCReceiveAddress is returned by ABCWallet routine createNewReceiveAddress and getReceiveAddress. The properties amountSatoshi and metaData can be modified by the caller.

Subsequent reads of the properties uri, address, and qrCode will automatically encompass the changes written to amountSatoshi and metaData. The values written to metaData will be written to the ABCTransaction for funds received on this address.

The following properties are passed into ABCReceiveAddress as details for the request

  amountSatoshi

Amount of satoshis to request. Optional. Set to zero if not needed

@property (nonatomic) int64_t amountSatoshi

Discussion

Amount of satoshis to request. Optional. Set to zero if not needed

Declared In

ABCReceiveAddress.h

  metaData

Optional meta to add to this request. Once money is received into this request address, the transaction will be tagged with this metadata such as payeeName category, and notes

@property (nonatomic, strong) ABCMetaData *metaData

Discussion

Optional meta to add to this request. Once money is received into this request address, the transaction will be tagged with this metadata such as payeeName category, and notes

Declared In

ABCReceiveAddress.h

The following properties are returned by ABC

  uri

Full request URI ie. “bitcoin:12kjhg9834gkjh4tjr1jhgSADG4GASf?amount=.2123&label=Airbitz&notes=Hello”

@property (nonatomic, copy) NSString *uri

Discussion

Full request URI ie. “bitcoin:12kjhg9834gkjh4tjr1jhgSADG4GASf?amount=.2123&label=Airbitz&notes=Hello”

Declared In

ABCReceiveAddress.h

  address

Bitcoin public address for request

@property (nonatomic, copy) NSString *address

Discussion

Bitcoin public address for request

Declared In

ABCReceiveAddress.h

  qrCode

QRCode of request in UIImage format for iOS and NSImage format for OSX

@property (nonatomic, copy) UIImage *qrCode

Discussion

QRCode of request in UIImage format for iOS and NSImage format for OSX

Declared In

ABCReceiveAddress.h

Instance Methods

– finalizeRequest

Finalizes the request so the address cannot be used by future requests. Forces address rotation so the next request gets a different address

- (NSError *)finalizeRequest

Return Value

NSError

Discussion

Finalizes the request so the address cannot be used by future requests. Forces address rotation so the next request gets a different address

Declared In

ABCReceiveAddress.h

– modifyRequestWithDetails

Modify a request based on the values in the ABCReceiveAddress structure. Normally the request would require that one of the parameters address, qrCode, or uri are readback before the metaData is saved with the address in ABC.

- (NSError *)modifyRequestWithDetails

Return Value

NSError

Discussion

Modify a request based on the values in the ABCReceiveAddress structure. Normally the request would require that one of the parameters address, qrCode, or uri are readback before the metaData is saved with the address in ABC.

Declared In

ABCReceiveAddress.h

– prioritizeAddress:

Tell ABC to constantly query this address to help ensure timely detection of funds on this address. Great to use when there is a QR code showing on screen.

- (void)prioritizeAddress:(BOOL)enable

Parameters

enable

BOOL Set to YES to prioritize this address. Set to NO to disable priority

Discussion

Tell ABC to constantly query this address to help ensure timely detection of funds on this address. Great to use when there is a QR code showing on screen.

Declared In

ABCReceiveAddress.h