CalendarService のデータ型

CalendarService はいくつかの複数のデータ型を定義して使用します。

カレンダーを表すオブジェクト。

プロパティ名	型	説明	例
id	String	カレンダーごとに固有の文字列化された数字。カレンダー作成時にネイティブデバイスによって生成されます。	"6544287"
title	String	カレンダーの名前。	"Awanasa's Calendar"
allowsContentModifications	Boolean	カレンダーが編集可能か (`true`)、参照のみか (`false`) を示します。	`false`
hexColor	String	デバイスの UI で、このカレンダーの行動に表示するアクセント色を指定します。有効な入力には、番号記号 (#) の後に 6 文字の 16 進数の色の値が含まれている必要があります。	"#009EDB"
type	String	カレンダーの種別に関するメタデータ。	"exchange"
isPrimary	Boolean	選択したカレンダーが、デバイスのデフォルトカレンダーであるかどうかを示します。	`true`

行動を表すオブジェクト。

プロパティ名	型	説明	例
`id`	String	行動ごとに固有の文字列化された数字。行動作成時にネイティブデバイスによって生成されます。	"7824456"
`isAllDay`	Boolean	行動が終日かどうかを示します。デフォルトは false です。	`true`
`startDateSecondsUTC`	Number	指定された表示範囲の開始日時を表します。	1667692800
`endDateSecondsUTC`	Number	指定された表示範囲の終了日時を取得します。	1668211200
`availability`	`EventAvailability`	行動の期間における参加者の空き状況を示します。デフォルト設定は「Busy」です。	"Busy"
`status`	`EventStatus`	このパラメータは読み取り専用です。ユーザが指定した値は、プラグインによって無視されます。	"Tentative"
`calendarId`	String	関連するカレンダーの id 値と一致します。	"6544287"
`title`	String	行動の名前。	"Chan's Birthday Party"
`location`	String	行動の場所。	"415 Mission St, San Francisco, CA, 94105"
`notes`	String	行動に関連付けられたその他のメモ。	"Don't forget to bring the cake!"
`alarms`	`Alarm[]`	行動の開始前にリマインダーを生成する時間を示します。	`{relativeOffsetSeconds: 3600}`
`attendees`	`Participant[]`	行動の被招集者をリストします。	`{name: "Alex Driskall", email: "alex_driskall@example.com", role: "Required", status: "Accepted"}`
`recurrenceRules`	`RecurrenceRule[]`	行動に対する任意の繰り返しルールを指定します。	`{frequency: "Monthly"}`

行動前に通知を生成する時間を表すオブジェクト。

プロパティ名	型	説明	例
relativeOffsetSeconds	Number	行動の前にリマインダー通知を生成する時間 (秒) を指定します。	1800

特定のカレンダーの行動に対する招待者を表すオブジェクト。

プロパティ名	型	説明	例
name	String	参加者の名前。	"Chan Ming Lewis"
email	String	参加者のメールアドレス。	"chan_ming_lewis_fake_email@employer.com"
role	`ParticipantRole`	招待者の出席の必要性のレベルを示します。	"Optional"
status	`ParticipantStatus`	招待者が行動に参加するかどうかを示します。	"Attending"

カレンダーの行動の定期的なケイデンスを表すオブジェクト。

プロパティ名	型	説明	例
`frequency`	`RecurrenceFrequency`	行動の繰り返し頻度を示します。	"Weekly"
`interval`	数値	行動の繰り返しを行う間隔を示します。デフォルトは 1 です。たとえば、`frequencyparameter` の値が「Weekly」で、`interval` の値が「3」の場合、行動は 3 週間ごとに繰り返されます。	3
`daysOfTheWeek`	`RecurrenceDayOfWeek[]	行動が発生する曜日を示します。	`{dayOfTheWeek: "Thursday"}`
`daysOfTheMonth`	`Number[]`	行動が何月何日に発生するかを示します。有効な値は、1 ～ 31 (両端を含む) の正の整数です。	5
`monthsOfTheYear`	`Number[]`	行動が何年何月に発生するかを示します。有効な値は、1 ～ 12 (両端を含む) の正の整数です。	6
`weeksOfTheYear`	`Number[]`	行動が何年の第何週に発生するかを示します。有効な値は、1 ～ 53 (両端を含む) の正の整数です。	17
`daysOfTheYear`	`Number[]`	行動が何年の何日に発生するかを示します。有効な値は、1 ～ 366 (両端を含む) の正の整数です。	200
`setPositions`	`Number[]`	ルールで指定された一連の繰り返しインスタンス内の n 番目の発生に対応する値をカンマで区切ったリストを指定します。この例は、`RecurrenceRule`オブジェクトで「月の 3 日目と 5 日目の平日」を表現することが可能であることを示しています。".	`{ frequency: "Monthly", daysOfTheWeek: {dayOfTheWeek: "Monday", "Tuesday", "Wednesday", "Thursday", "Friday"}, setPositions, 3, 5 }`
`end`	`RecurrenceEnd`	行動の繰り返しが終了する時間を示します。	`{occurrenceCount: 8}\`

繰り返しルールのプロパティは、標準化された iCalendar データ形式に従って定義します。iCalendar 形式の仕様の詳細については、「Internet Calendaring and Scheduling Core Object Specification (インターネットカレンダーとスケジューリングコアオブジェクト仕様)」を参照してください。

カレンダーの行動について毎週の定期的なケイデンスを指定するオブジェクト。

プロパティ名	型	説明	例
dayOfTheWeek	`Weekday`	曜日を示します。	"Monday"
weekNumber	`Number[]`	カレンダー年の週番号を示します。有効な値は、1 ～ 53 (両端を含む) の正の整数です。	25

カレンダーの行動の定期的なケイデンスの終了を指定するオブジェクト。

プロパティ名	型	説明	例
endDateSecondsUTC	Number	指定された定期的な行動の終了日時を取得します。	1668211200
occurrenceCount	Number	行動の繰り返し回数を表します。	12

1 つの行動の更新または削除に影響を受ける定期的な行動の個々の行動を指定するオブジェクト。

プロパティ名	型	説明	例
span	`Span`	定期的な行動の更新や削除を、指定した個別の行動にのみ適用するか、指定した個別の行動と以降に発生するすべての定期的な行動に適用するかを示します。	"ThisAndFollowingEvents"

CalendarService の機能にアクセスしたときに発生するエラーを表すオブジェクト。

プロパティ名	型	説明
code	`CalendarServiceFailureCode`	カレンダーのエラーが発生した理由を表す値。利用可能な値のリストについては、CalendarService の定数の `CalendarServiceFailureCode` を参照してください。
message	String	失敗した理由を説明する文字列値。この値は、ユーザエラーメッセージでの使用に適しています。メッセージは英語で表示されます。日本語化はされていません。