Class OccurrenceContext

Class representing an occurrence of an event. Attributes: date_start (dt.datetime): Start date of occurrence range (inclusive). date_end (dt.datetime): End date of occurrence range (inclusive), default is None. freqtype (str): Frequency of event occurrence (e.g., 'hourly', 'daily'), default is 'YEARLY'. freq (int): Frequency of freqType in terms of an rrule. interval (int): Interval for occurrence, once every specified frequency, default is 1. count (int): Number of times to repeat, default is None. custom_dow (Dict[str, List[int]]): Custom days of week for repeat (e.g., {'MO': [1, -1], 'TU': [2]}), default is None. Positive number (e.g., 1) for 1st Monday of month. Negative number (e.g., -1) for last Monday of month. Zero for every Monday of month. day_rules (List[weekday]): List of weekday objects derived from custom_dow. custom_month (List[int]): Months (integers) to filter event to. upper_shoulder (dt.timedelta): Upper shoulder duration of event, default is None. lower_shoulder (dt.timedelta): Lower shoulder duration of event, default is None.

Namespace: Workspace.XBR.Xperiflow.Core.RestApi.Generators

Assembly: Xperiflow.dll

Declaration

public class OccurrenceContext

Properties

DateStart

Declaration

[JsonProperty("date_start", Required = Required.Always)]
public DateTime DateStart { get; set; }

DateEnd

Declaration

[JsonProperty("date_end", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public DateTime? DateEnd { get; set; }

Freqtype

Declaration

[JsonProperty("freqtype", Required = Required.DisallowNull, NullValueHandling = NullValueHandling.Ignore)]
public string? Freqtype { get; set; }

Interval

Declaration

[JsonProperty("interval", Required = Required.DisallowNull, NullValueHandling = NullValueHandling.Ignore)]
public int? Interval { get; set; }

Count

Declaration

[JsonProperty("count", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public int? Count { get; set; }

UpperShoulder

Declaration

[JsonProperty("upper_shoulder", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public TimeSpan? UpperShoulder { get; set; }

LowerShoulder

Declaration

[JsonProperty("lower_shoulder", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public TimeSpan? LowerShoulder { get; set; }

CustomDow

Declaration

[JsonProperty("custom_dow", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public IDictionary<string, IEnumerable<int>>? CustomDow { get; set; }

CustomMonth

Declaration

[JsonProperty("custom_month", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public IEnumerable<int>? CustomMonth { get; set; }

AdditionalProperties

Declaration

[JsonExtensionData]
public IDictionary<string, object> AdditionalProperties { get; set; }

Methods

ToJson()

Declaration

public string ToJson()

Returns

System.String

FromJson(string)

Declaration

public static OccurrenceContext FromJson(string data)

Returns

Workspace.XBR.Xperiflow.Core.RestApi.Generators.OccurrenceContext

Parameters

Type	Name
System.String	data

Inherited Members

• System.Object.Equals(System.Object)
• System.Object.Equals(System.Object,System.Object)
• System.Object.GetHashCode
• System.Object.GetType
• System.Object.MemberwiseClone
• System.Object.ReferenceEquals(System.Object,System.Object)
• System.Object.ToString