SdlMsgVersion Class Reference
Constructors
Instance Methods
- getMajorVersion() ⇒
Number - getMinorVersion() ⇒
Number - getPatchVersion() ⇒
Number - setMajorVersion(version) ⇒
SdlMsgVersion - setMinorVersion(version) ⇒
SdlMsgVersion - setPatchVersion(version) ⇒
SdlMsgVersion
Instance Methods
sdlMsgVersion.getMajorVersion() ⇒ Number
Get the MajorVersion
Kind: Instance method of SdlMsgVersion
Returns: Number - the KEY_MAJOR_VERSION value
sdlMsgVersion.getMinorVersion() ⇒ Number
Get the MinorVersion
Kind: Instance method of SdlMsgVersion
Returns: Number - the KEY_MINOR_VERSION value
sdlMsgVersion.getPatchVersion() ⇒ Number
Get the PatchVersion
Kind: Instance method of SdlMsgVersion
Returns: Number - the KEY_PATCH_VERSION value
sdlMsgVersion.setMajorVersion(version) ⇒ SdlMsgVersion
Set the MajorVersion
Kind: Instance method of SdlMsgVersion
Returns: SdlMsgVersion - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| version | Number |
The major version indicates versions that is not-compatible to previous versions. - The desired MajorVersion. {'num_min_value': 1, 'num_max_value': 10} |
sdlMsgVersion.setMinorVersion(version) ⇒ SdlMsgVersion
Set the MinorVersion
Kind: Instance method of SdlMsgVersion
Returns: SdlMsgVersion - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| version | Number |
The minor version indicates a change to a previous version that should still allow to be run on an older version (with limited functionality) - The desired MinorVersion. {'num_min_value': 0, 'num_max_value': 1000} |
sdlMsgVersion.setPatchVersion(version) ⇒ SdlMsgVersion
Set the PatchVersion
Kind: Instance method of SdlMsgVersion
Returns: SdlMsgVersion - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| version | Number |
The patch version indicates a fix to existing functionality in a previous version that should still be able to be run on an older version - The desired PatchVersion. {'num_min_value': 0, 'num_max_value': 1000} |