Class TimeAndLocation

Class that notifies its parent ManagedSettigns or ManagedSubSettings object when one of its members changes.

Index

Constructors

Accessors

day hour isEnabled latitude longitude minute month year

Methods

markAsDirty modify

Constructors

constructor

new TimeAndLocation(
    isEnabled?: boolean,
    year?: number,
    month?: number,
    day?: number,
    hour?: number,
    minute?: number,
    isInternalConstructor?: boolean,
): TimeAndLocation
Parameters
- OptionalisEnabled: boolean
- Optionalyear: number
- Optionalmonth: number
- Optionalday: number
- Optionalhour: number
- Optionalminute: number
- OptionalisInternalConstructor: boolean
Returns TimeAndLocation

Overrides FrameworkObject.constructor

Accessors

day

get day(): number

The day of the month.

Returns number
set day(value: number): void
Parameters
- value: number
Returns void

hour

get hour(): number

The hour of the day.

Returns number
set hour(value: number): void
Parameters
- value: number
Returns void

isEnabled

get isEnabled(): boolean

Returns boolean
set isEnabled(value: boolean): void
Parameters
- value: boolean
Returns void

latitude

get latitude(): number

The longitude.

Returns number
set latitude(value: number): void
Parameters
- value: number
Returns void

longitude

get longitude(): number

The longitude.

Returns number
set longitude(value: number): void
Parameters
- value: number
Returns void

minute

get minute(): number

The minute of the day.

Returns number
set minute(value: number): void
Parameters
- value: number
Returns void

month

get month(): number

The month of the year.

Returns number
set month(value: number): void
Parameters
- value: number
Returns void

year

get year(): number

The year.

Returns number
set year(value: number): void
Parameters
- value: number
Returns void

Methods

markAsDirty

markAsDirty(dirtyFlags: EnumValue<ManagedSettingsDirtyFlag>): void
Marks the object as dirty.
Parameters
- dirtyFlags: EnumValue<ManagedSettingsDirtyFlag>
  Flags specifying what kind of member was changed.
Returns void

modify

modify(action: () => void): void
Allows modifying this object multiple times in a row in a scope, without marking the object dirty immediately. Dirty flags are accumulated and the object is marked dirty at the end.
Parameters
- action: () => void
  The scope where the object is modified.
Returns void