| LunchBreak Class |
Container class for Lunches and Breaks.
Inheritance HierarchyNamespace: AMG.API.Definitions.Shifts
Assembly: AMG.API (in AMG.API.dll) Version: 2.0.0.0 (2.0.0.0)
SyntaxThe LunchBreak type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | LunchBreak |
Initializes a new instance of the LunchBreak class.
|
Properties| Name | Description | |
|---|---|---|
 | ApplyMode | Describes how this Lunch/Break is being applied. enum En_ApplyMode { Elapsed = 0, Punched = 1, Elapsed or Punched = 2, Fixed = 3 } |
| Duration |
Duration of the lunch/break.
|
| Elapsed |
Amount of hours after which a lunch/break will be automatically deducted. Note that this field will be active only
if ApplyMode is set to Elapsed, Elapsed or Punched or Fixed.
|
| From | Defines whether the elapsed time should be counted from the Shift Start time or actual Clock in time. Note that this field will be active only if ApplyMode is set to Elapsed, Elapsed or Punched or Fixed. enum En_ElapsedDeduct { Shift (Shift Start) = 1, Punch (IN Punch) = 2 } |
| IsPaid |
Indicates if this Lunch/Break is paid.
|
| MaxPunch |
The amount of hours within which employee (starting either from Shift Start time or actual Clock in time) should
punch for lunch.
|
| MinimumDuration |
Minimum duration of the lunch/break. Note that if the duration of transaction is less than the minimum duration,
then the system won't consider the transaction as a lunch/break.
|
| MinWork |
Shows how many hours prior to lunch start time employee should punch IN.
If employee punches later, then Fixed lunch is not being applied and instead is being applied Elapsed lunch.
Note that this field will be active only if ApplyMode is set to Fixed.
|
| PayOutside | |
| RestrictDuration |
Set this option if you want short duration lunch or break to be denied.
It means that after performing "Out for Lunch" and "Out for Break" punches from the device,
employees wouldn't be able to perform any other action from the device until the lunch or break duration is over.
Take into consideration that this feature doesn't apply for all device types,
but only for the following ones: AMG-FP30, AMG-FP90 and new TM 2010-B,
and also only in case "Punch Menu" is selected as "Menu Type".
|
| StartAt |
The start time of Fixed lunch. Note that this field will be active only if ApplyMode is set to
Fixed.
|
| Type | The type of item. enum En_RoundingType { Lunch = 1, Break = 2 } |
See Also