ClosingDetailImageRefType Property
Type of retrieval method for actual statement closing image.
Syntax
ccstatement.getClosingDetailImageRefType(index, [callback])
Default Value
""
Callback
The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).
The callback for the getClosingDetailImageRefType([callback]) method is defined as:
function(err, data){ }
'err' is the error that occurred. If there was no error, then 'err' is 'null'.
'data' is the value returned by the method.
The callback for the setClosingDetailImageRefType([callback]) method is defined as:
function(err){ }
'err' is the error that occurred. If there was no error, then 'err' is 'null'.
'err' has 2 properties which hold detailed information:
err.code err.message
Remarks
Type of retrieval method for actual statement closing image.
If ClosingDetailImageRef is returned in the response, this can be either image identifier (to be used during the request for the image when the GetImage method is called) or a URL.
Possible values for ClosingDetailImageRefType are:
Value | Meaning |
OPAQUE | Requires the client to send a separate OFX request to access the image. The image can be retrieved by calling the GetImage method where ClosingDetailImageRef will be the parameter value for this method. |
URL | The image is accessed directly via the URL provided. The client will not provide authentication and will simply follow the URL provided. |
FORMURL | The image is accessed directly via an encoded URL. The client will send authentication to the server. |
The index parameter specifies the index of the item in the array. The size of the array is controlled by the ClosingDetailCount property.
This property is read-only and not available at design time.
Data Type
String