Click or drag to resize

Time Class

Check Point Time Object class
Inheritance Hierarchy
SystemObject
  Koopman.CheckPoint.CommonSimpleChangeTracking
    Koopman.CheckPoint.CommonChangeTracking
      Koopman.CheckPointObjectSummaryTime
        Koopman.CheckPoint.CommonObjectBaseTime
          Koopman.CheckPointTime

Namespace:  Koopman.CheckPoint
Assembly:  CheckPoint.NET (in CheckPoint.NET.dll) Version: 0.5.1
Syntax
C#
Copy
public class Time : ObjectBase<Time>, ITimeGroupMember, 
	IObjectSummary
Request Example View Source

The Time type exposes the following members.

Constructors
  NameDescription
Public methodCode exampleTime
Create new Time object.
Top
Properties
  NameDescription
Public propertyColor
Color of the object
(Inherited from ObjectBaseT.)
Public propertyComments
Comments string
(Inherited from ObjectBaseT.)
Public propertyDetailLevel
Gets the current detail level of retrieved objects. You will not be able to get the values of some properties if the detail level is too low. You can still set property values however to override existing values.
(Inherited from ObjectSummaryT.)
Public propertyDomain
Information about the domain the object belongs to.
(Inherited from ObjectSummaryT.)
Public propertyEnd
Gets or sets the End time. Note: Each gateway may interpret this time differently according to its time zone.
Public propertyEndNever
Gets or sets a value indicating whether this Time object should never end.
Public propertyGroups
Gets the time groups.
Public propertyHourRanges
Gets or sets the Hours recurrence. Note: Each gateway may interpret this time differently according to its time zone.
Public propertyIcon
Object icon
(Inherited from ObjectBaseT.)
Public propertyIsChanged
Gets the object's changed status. Includes checking status of all IChangeTracking properties.
(Inherited from ChangeTracking.)
Public propertyIsNew
Gets a value indicating whether this instance is new.
(Inherited from SimpleChangeTracking.)
Public propertyMetaInfo
Meta Information
(Inherited from ObjectBaseT.)
Public propertyName
Object name. Should be unique in the domain.
(Inherited from ObjectSummaryT.)
Public propertyObjectType
The object type.
(Overrides ObjectSummaryTObjectType.)
Public propertyReadOnly
Indicates whether the object is read-only
(Inherited from ObjectBaseT.)
Public propertyRecurrence
Gets or sets the days recurrence.
Public propertyStart
Gets or sets the Starting time. Note: Each gateway may interpret this time differently according to its time zone.
Public propertyStartNow
Gets or sets a value indicating whether to start now.
Public propertyTags
Tags assigned to object
(Inherited from ObjectBaseT.)
Public propertyType
Type of the object.
(Overrides ObjectSummaryTType.)
Public propertyUID
Object unique identifier.
(Inherited from ObjectSummaryT.)
Top
Methods
  NameDescription
Public methodAcceptChanges(CancellationToken)
Same as calling AcceptChanges(Ignore, CancellationToken) with a value of No;
(Inherited from ObjectSummaryT.)
Public methodAcceptChanges(Ignore, CancellationToken)
Posts all changes to Check Point server. If successful all object properties will be updated with results.
(Inherited from ObjectSummaryT.)
Public methodDelete
Deletes the current object.
(Inherited from ObjectSummaryT.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetIdentifier
Gets the identifier that is used when adding this object to a group.
(Inherited from ObjectSummaryT.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodReload
Reloads the current object. Used to either reset changes made without saving, or to increased the detailLevel to Full
(Inherited from ObjectSummaryT.)
Public methodToString
Returns a String that represents this object.
(Inherited from ObjectSummaryT.)
Top
Examples
Add new time object using Time(Session, Boolean)
Copy
var t = new Time(Session)
{
Name = "MyTime",
Color = Colors.Red
};
t.HourRanges[0] = new Koopman.CheckPoint.Common.TimeRange("03:00", "04:00");
t.HourRanges[1] = new Koopman.CheckPoint.Common.TimeRange("15:00", "16:00");
t.Recurrence = new Time.RecurrenceClass() {
Pattern = Time.RecurrencePattern.Daily,
Weekdays = Days.Saturday | Days.Sunday
};
t.AcceptChanges();
Find time object using FindTime(String, DetailLevels, CancellationToken)
Copy
var t = Session.FindTime("MyTime");
See Also