aboutsummaryrefslogtreecommitdiffstats
path: root/lib/public/Calendar/CalendarExportOptions.php
blob: bf21dd85ae49d7dac8451b827b23489d37d0ec8f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
<?php

declare(strict_types=1);

/**
 * SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
 * SPDX-License-Identifier: AGPL-3.0-or-later
 */
namespace OCP\Calendar;

/**
 * Calendar Export Options
 *
 * @since 32.0.0
 */
final class CalendarExportOptions {

	/** @var 'ical'|'jcal'|'xcal' */
	private string $format = 'ical';
	private ?string $rangeStart = null;
	private ?int $rangeCount = null;

	/**
	 * Gets the export format
	 *
	 * @return 'ical'|'jcal'|'xcal' (defaults to ical)
	 */
	public function getFormat(): string {
		return $this->format;
	}

	/**
	 * Sets the export format
	 *
	 * @param 'ical'|'jcal'|'xcal' $format
	 */
	public function setFormat(string $format): void {
		$this->format = $format;
	}

	/**
	 * Gets the start of the range to export
	 */
	public function getRangeStart(): ?string {
		return $this->rangeStart;
	}

	/**
	 * Sets the start of the range to export
	 */
	public function setRangeStart(?string $rangeStart): void {
		$this->rangeStart = $rangeStart;
	}

	/**
	 * Gets the number of objects to export
	 */
	public function getRangeCount(): ?int {
		return $this->rangeCount;
	}

	/**
	 * Sets the number of objects to export
	 */
	public function setRangeCount(?int $rangeCount): void {
		$this->rangeCount = $rangeCount;
	}
}