GetVersion

This section describes one of the fraud screening methods used in the development of fraud screening plugins that allow CloudBlue Commerce to integrate with third-party fraud screening systems. For more information, refer to Overview and How to Develop Fraud Screening Plugins.

Method naming convention

%PluginName%_GetVersion

Purpose

This method is used for CloudBlue Commerce to receive the major and minor version parts as an array comprised of two integers: [major, minor] (for example, [0,9] for "0.9", the default is [1,0], that is "1.0"). The plug-in version is displayed on the plug-in configuration page in CloudBlue Commerce provider control panel.

Mandatory / optional

Important: Although this is one of the generic methods that technically can be implemented optionally, we strongly recommend that this method be implemented in all plugins because it is necessary when synchronizing plugin package updates to Billing. While developing a plugin, after you make changes to the set of plug-in configuration parameters, the set of account attributes, the blacklist schema or definitions of other entities to be registered in Billing, the plugin version number must be increased. Otherwise, Billing will not recognize the changes when the plugin package is updated.

Input Parameters

None.

Return Parameters

• version: an object of the \FraudSDK\Version type that describes the major and minor version parts.

Relationship with other methods

None.

Implementation example. Blacklist plugin

function BlacklistDemo_GetVersion()
{
    return \FraudSDK\createVersion()
           ->setMajor(0)
           ->setMinor(9);
}