-
Notifications
You must be signed in to change notification settings - Fork 2
Cblabs.CybozuConnect.Schedule
hatashinya edited this page Nov 14, 2012
·
1 revision
スケジュールの個人設定を表すクラス
- res (Object)
APIからのレスポンス
plan_menu()
予定メニュー
(Array)
予定メニュー項目の配列
スケジュールのシステム設定を表すクラス
- res (Object)
APIからのレスポンス
plan_menu()
予定メニュー
(Array)
予定メニュー項目の配列
show_group_event()
グループの予定を表示するか否か
(Boolean)
Scheduleで提供されるAPIを実行するクラス
予定を取得する期間の指定について
例えば 2011-01-16 から 2011/01/22 までの予定を取得する場合、 開始日時として 2011-01-16 00:00:00 を指定し、 終了日時として 2011-01-23 00:00:00 を指定する。
予定情報の属性
var event = {
id: "1", // 予定ID
allDay: false, // 終日予定（バナー予定を含む）か否か
start: new Date(2011, 0, 28, 10, 0), // 開始日時
end: new Date(2011, 0, 28, 11, 0), // 終了日時
event_type: "repeat", // 予定の種類
public_type: "public", // 公開方法（"public": 公開、"private": 非公開）
plan: "会議", // 予定メニュー
detail: "進捗", // 予定詳細
title: "会議:進捗", // 予定メニュー＋予定詳細
description: "要議事録", // メモ
timezone: "Asia/Tokyo", // タイムゾーン
start_only: false, // 開始時刻のみ設定されているか否か
users: [], // 参加するユーザーの配列（予定取得時）
organizations: [], // 参加する組織の配列（予定取得時）
facilities: [], // 参加する設備の配列（予定取得時）
userIdList: ["1", "2"], // 参加するユーザーのIDの配列（予定追加・変更時）
orgIdList: ["1"], // 参加する組織のIDの配列（予定追加・変更時）
facilityIdList: ["5"], // 参加する設備のIDの配列（予定追加・変更時）
repeatInfo: { // 繰り返し情報（繰り返し予定の場合）
type: "week", // 繰り返しの種類
day: "28", // type=="month" の場合の日指定
week: "5", // type=="week"/"1stweek"/"2ndweek"/"3rdweek"/"4thweek"/"lastweek" の場合の曜日指定
start_date: "2011-01-28", // 繰り返し期間の開始日付（xsd:date）
end_date: "2011-02-28", // 繰り返し期間の終了日付（xsd:date）
start_time: "10:00:00", // 開始時刻（xsd:time）
end_time: "11:00:00" // 終了時刻（xsd:time）
}
};
予定の種類
繰り返しの種類
設備情報の属性
var facility = {
id: "5", // 設備ID
key: "5", // 設備ID
name: "会議室１", // 設備名
description: "", // メモ
belong_facility_group_id: "1" // 所属する設備グループ
};
設備グループの属性
var facilityGroup = {
id: "1", // 設備グループID
key: "1", // 設備グループID
name: "会議室", // 設備グループ名
facilityIdList: ["5"], // 所属する設備のIDの配列
parent_facility_group_id: null // 親設備グループ
};
- app (CBLabs.CybozuConnect.App)
addEvent(event, visStart, visEnd)
予定を追加する。
- event (Object)
追加する予定の情報- visStart (Date)
（戻り値としての予定を）取得する期間の開始日時- visEnd (Date)
（戻り値としての予定を）取得する期間の終了日時(Array)
追加された予定の配列
addFollow(event, followText)
フォローを予定に追加する。
- event (Object/String)
フォローを追加する先の予定、または予定ID- followText (String)
フォロー内容(Object)
フォローが追加された予定
addFollows(follows)
フォローを予定に追加する。
- follows (Object/Array)
フォロー（の配列）(Array)
フォローが追加された予定の配列
addFollowsToRepeatEvent(follows)
フォローを繰り返し予定に追加する。
- follows (Object/Array)
フォロー（の配列）
addFollowToRepeatEvent(event, date, followText)
フォローを繰り返し予定に追加する。
- event (Object/String)
フォローを追加する先の予定、または予定ID- date (Date)
フォローを追加する先の予定の日付- followText (String)
フォロー内容
facility(facilityId)
指定した設備の情報を取得する
- facilityId (String)
設備ID(Object)
設備情報
facilityGroup(groupId)
指定した設備グループの情報を返す。
- groupId (String)
設備グループID(Object)
設備グループ情報
facilityGroupList()
トップレベルの設備グループを返す
(Array)
設備グループ情報の配列
facilityList()
全設備を取得する。
(Array)
設備の配列
facilitySearch(text)
設備を検索する
- text (String)
検索文字列(Array)
ヒットした設備情報の配列
getEvents(options)
指定した複数の対象の予定を返す。
- options
(Array)
予定の配列
getEventsByTarget(options)
指定した対象の予定を返す。
- options
(Array)
予定の配列ユーザーID、組織ID、および設備IDのうち、いずれか１つだけ指定できる。
inMembers(userId, event)
指定したユーザーが予定の参加者に含まれるか否か
- userId (String)
ユーザーID- event (Object)
予定(Boolean)
isHierarchical()
設備グループが階層的か否か
(Boolean)
leaveEvent(eventId)
（繰り返し以外の）予定から抜ける。
- eventId (String)
予定ID
leaveEventFromRepeatEvent(eventId, type, date)
繰り返し予定から抜ける。
- eventId (String)
予定ID- type (String)
抜ける範囲（"this"/"after"/"all"）- date (Date)
抜ける範囲の基準日付
modifyEvent(event)
（繰り返し以外の）予定を変更する。
- event (Object)
変更する予定の情報(Boolean)
true: 成功、false: 失敗
modifyRepeatEvent(event, modifyType, baseDate, modifyDate)
繰り返し予定を変更する。
- event (Object)
変更する予定の情報- modifyType (String)
変更する範囲（"this": baseDate で指定した日付のみ、"after": baseDate 以降について、"all": すべて）- baseDate (Date)
変更する範囲の基準日付（modifyType の項を参照）- modifyDate (Date)
modifyType=="this" のとき、変更先の日付。modifyType=="after" のとき、変更後予定の繰り返し期間の開始日付。(Boolean)
true: 成功、false: 失敗
personalProfile()
スケジュールの個人設定を返す。
(CBLabs.CybozuConnect.SchedulePersonalProfile)
removeEvent(eventId)
（繰り返し以外の）予定を削除する。
- eventId (String)
予定ID
removeEventFromRepeatEvent(eventId, type, date)
繰り返し予定を削除する。
- eventId (String)
予定ID- type (String)
削除する範囲（"this"/"after"/"all"）- date (Date)
削除する範囲の基準日付
removeFollows(followIds)
フォローを削除する。
- followIds (String/Array)
フォローID（の配列）
systemProfile()
スケジュールのシステム設定を返す。
(CBLabs.CybozuConnect.ScheduleSystemProfile)