Class NSTimeZoneAgent
TimeZone maintenance.
Syntax
Examples
NSTimeZoneAgent agent;
agent.callMethod(arg1, arg2);Constructors
NSTimeZoneAgent()
TimeZone maintenance.
Introduced or updated in version: 7
Declaration
NSTimeZoneAgentExamples
NSTimeZoneAgent agent;
agent.callMethod(arg1, arg2);Methods
CheckNewTimeZoneDataAvailable()
Checks to see if new timezone data is available
Introduced or updated in version: 7.5
Declaration
Bool CheckNewTimeZoneDataAvailable()Returns
| Type | Description |
|---|---|
| Bool |
Examples
NSTimeZoneAgent agent;
Bool res = agent.CheckNewTimeZoneDataAvailable();DeleteTimeZones()
Deletes all time zone data (locations and rules) from the database
Introduced or updated in version: 7.5
Declaration
Void DeleteTimeZones()Returns
| Type | Description |
|---|---|
| Void |
GetBaseTimeZoneId()
Gets the base timezone ID.
Introduced or updated in version: 7
Declaration
Integer GetBaseTimeZoneId()Returns
| Type | Description |
|---|---|
| Integer |
Examples
NSTimeZoneAgent agent;
Integer res = agent.GetBaseTimeZoneId();GetDefaultTimeZonePreference()
Returns the ID of the default timezone preference with deflevel system wide
Introduced or updated in version: 7.5
Declaration
Integer GetDefaultTimeZonePreference()Returns
| Type | Description |
|---|---|
| Integer |
Examples
NSTimeZoneAgent agent;
Integer res = agent.GetDefaultTimeZonePreference();InitializeTimeZoneData()
Initializes the NSTimeZoneData
Introduced or updated in version: 7
Declaration
NSTimeZoneData[] InitializeTimeZoneData()Returns
| Type | Description |
|---|---|
| NSTimeZoneData[] |
SetActiveTimeZoneRow(Integer,Bool)
Sets active state of singe row in the TZLocation table
Introduced or updated in version: 7.5
Declaration
Void SetActiveTimeZoneRow(Integer id, Bool active)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | id | |
| Bool | active |
Returns
| Type | Description |
|---|---|
| Void |
SetActiveTimeZonesByFilter(String,Bool)
Toggles active state of a single row in the TZLocation table
Introduced or updated in version: 7.5
Declaration
Void SetActiveTimeZonesByFilter(String filter, Bool active)Parameters
| Type | Name | Description |
|---|---|---|
| String | filter | |
| Bool | active |
Returns
| Type | Description |
|---|---|
| Void |
SetBaseTimeZoneId(Integer)
Sets the base timezone ID.
Introduced or updated in version: 7.5
Declaration
Bool SetBaseTimeZoneId(Integer timezoneId)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | timezoneId |
Returns
| Type | Description |
|---|---|
| Bool |
Examples
NSTimeZoneAgent agent;
Integer timezoneId;
Bool res = agent.SetBaseTimeZoneId(timezoneId);TimeOfLastTimeZoneUpdate()
Gets the time time zone data was last updated
Introduced or updated in version: 7.5
Declaration
DateTime TimeOfLastTimeZoneUpdate()Returns
| Type | Description |
|---|---|
| DateTime |
Examples
NSTimeZoneAgent agent;
DateTime res = agent.TimeOfLastTimeZoneUpdate();ToggleActiveTimeZoneRow(Integer)
Toggles active state of a single row in the TZLocation table
Introduced or updated in version: 7.5
Declaration
Void ToggleActiveTimeZoneRow(Integer id)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | id |
Returns
| Type | Description |
|---|---|
| Void |
UpdateTimeZoneData()
Retrieves time zone data from the SuperOffice server and update TimeZone data in the database
Introduced or updated in version: 7.5
Declaration
Bool UpdateTimeZoneData()Returns
| Type | Description |
|---|---|
| Bool |
Examples
NSTimeZoneAgent agent;
Bool res = agent.UpdateTimeZoneData();