overwolf.os API
Use this API for Operating System related functionalities.
Methods Reference
Types Reference
- overwolf.os.GetRegionInfoResult Object
- overwolf.os.RegionInfo Object
getRegionInfo(callback)
Version added: 0.132
Returns regional information about the user.
| Parameter | Type | Description |
|---|---|---|
| callback | (Result: GetRegionInfoResult) => void | Returns with the result |
GetRegionInfoResult Object
| Parameter | Type | Description |
|---|---|---|
| success | boolean | inherited from the "Result" Object |
| error | string | inherited from the "Result" Object |
| status | string | deprecated. For backward compatibility only |
| Reason | string | deprecated. For backward compatibility only |
| info | RegionInfo Object | Region Info |
Example data: Success
{
"success": true,
"info":
{
"date_format": "M/d/yyyy",
"time_format": "h:mm:ss tt",
"currency_symbol": "$",
"is_metric": false,
"name": "en-US"}
}
}
RegionInfo Object
| Parameter | Type | Description |
|---|---|---|
| date_format | string | |
| time_format | string | |
| currency_symbol | string | |
| is_metric | boolean | |
| name | string |