==================================================== GS2-Schedule ==================================================== **Create Client** .. code-block:: lua schedule_client = client('schedule') .. contents:: 目次 :local: :depth: 2 Method ==================================================== ---------------------------------------------------- create_event_master ---------------------------------------------------- .. code-block:: lua response = schedule_client:create_event_master(request) if response.isError then -- エラー処理 -- print(response.statusCode) print(response.errorMessage) else -- 正常処理 -- print(response.result) end イベントマスターを新規作成します Request ---------------------------------------------------- .. include:: control/CreateEventMasterRequest.rst Response ---------------------------------------------------- .. include:: control/CreateEventMasterResult.rst ---------------------------------------------------- create_schedule ---------------------------------------------------- .. code-block:: lua response = schedule_client:create_schedule(request) if response.isError then -- エラー処理 -- print(response.statusCode) print(response.errorMessage) else -- 正常処理 -- print(response.result) end スケジュールを新規作成します Request ---------------------------------------------------- .. include:: control/CreateScheduleRequest.rst Response ---------------------------------------------------- .. include:: control/CreateScheduleResult.rst ---------------------------------------------------- delete_event_master ---------------------------------------------------- .. code-block:: lua response = schedule_client:delete_event_master(request) if response.isError then -- エラー処理 -- print(response.statusCode) print(response.errorMessage) else -- 正常処理 -- print(response.result) end イベントマスターを削除します Request ---------------------------------------------------- .. include:: control/DeleteEventMasterRequest.rst Response ---------------------------------------------------- None ---------------------------------------------------- delete_schedule ---------------------------------------------------- .. code-block:: lua response = schedule_client:delete_schedule(request) if response.isError then -- エラー処理 -- print(response.statusCode) print(response.errorMessage) else -- 正常処理 -- print(response.result) end スケジュールを削除します Request ---------------------------------------------------- .. include:: control/DeleteScheduleRequest.rst Response ---------------------------------------------------- None ---------------------------------------------------- delete_trigger ---------------------------------------------------- .. code-block:: lua response = schedule_client:delete_trigger(request) if response.isError then -- エラー処理 -- print(response.statusCode) print(response.errorMessage) else -- 正常処理 -- print(response.result) end トリガーを削除します Request ---------------------------------------------------- .. include:: control/DeleteTriggerRequest.rst Response ---------------------------------------------------- None ---------------------------------------------------- describe_event ---------------------------------------------------- .. code-block:: lua response = schedule_client:describe_event(request) if response.isError then -- エラー処理 -- print(response.statusCode) print(response.errorMessage) else -- 正常処理 -- print(response.result) end 開催中のイベントの一覧を取得します Request ---------------------------------------------------- .. include:: control/DescribeEventRequest.rst Response ---------------------------------------------------- .. include:: control/DescribeEventResult.rst ---------------------------------------------------- describe_event_by_user_id ---------------------------------------------------- .. code-block:: lua response = schedule_client:describe_event_by_user_id(request) if response.isError then -- エラー処理 -- print(response.statusCode) print(response.errorMessage) else -- 正常処理 -- print(response.result) end 開催中のイベントの一覧を取得します Request ---------------------------------------------------- .. include:: control/DescribeEventByUserIdRequest.rst Response ---------------------------------------------------- .. include:: control/DescribeEventByUserIdResult.rst ---------------------------------------------------- describe_event_master ---------------------------------------------------- .. code-block:: lua response = schedule_client:describe_event_master(request) if response.isError then -- エラー処理 -- print(response.statusCode) print(response.errorMessage) else -- 正常処理 -- print(response.result) end イベントマスターの一覧を取得します Request ---------------------------------------------------- .. include:: control/DescribeEventMasterRequest.rst Response ---------------------------------------------------- .. include:: control/DescribeEventMasterResult.rst ---------------------------------------------------- describe_schedule ---------------------------------------------------- .. code-block:: lua response = schedule_client:describe_schedule(request) if response.isError then -- エラー処理 -- print(response.statusCode) print(response.errorMessage) else -- 正常処理 -- print(response.result) end スケジュールの一覧を取得します Request ---------------------------------------------------- .. include:: control/DescribeScheduleRequest.rst Response ---------------------------------------------------- .. include:: control/DescribeScheduleResult.rst ---------------------------------------------------- describe_trigger ---------------------------------------------------- .. code-block:: lua response = schedule_client:describe_trigger(request) if response.isError then -- エラー処理 -- print(response.statusCode) print(response.errorMessage) else -- 正常処理 -- print(response.result) end トリガーの一覧を取得します Request ---------------------------------------------------- .. include:: control/DescribeTriggerRequest.rst Response ---------------------------------------------------- .. include:: control/DescribeTriggerResult.rst ---------------------------------------------------- describe_trigger_by_user_id ---------------------------------------------------- .. code-block:: lua response = schedule_client:describe_trigger_by_user_id(request) if response.isError then -- エラー処理 -- print(response.statusCode) print(response.errorMessage) else -- 正常処理 -- print(response.result) end ユーザのトリガーの一覧を取得します Request ---------------------------------------------------- .. include:: control/DescribeTriggerByUserIdRequest.rst Response ---------------------------------------------------- .. include:: control/DescribeTriggerByUserIdResult.rst ---------------------------------------------------- export_master ---------------------------------------------------- .. code-block:: lua response = schedule_client:export_master(request) if response.isError then -- エラー処理 -- print(response.statusCode) print(response.errorMessage) else -- 正常処理 -- print(response.result) end イベントマスターをエクスポートします Request ---------------------------------------------------- .. include:: control/ExportMasterRequest.rst Response ---------------------------------------------------- .. include:: control/ExportMasterResult.rst ---------------------------------------------------- get_current_event_master ---------------------------------------------------- .. code-block:: lua response = schedule_client:get_current_event_master(request) if response.isError then -- エラー処理 -- print(response.statusCode) print(response.errorMessage) else -- 正常処理 -- print(response.result) end 現在適用されているイベントマスターを取得します Request ---------------------------------------------------- .. include:: control/GetCurrentEventMasterRequest.rst Response ---------------------------------------------------- .. include:: control/GetCurrentEventMasterResult.rst ---------------------------------------------------- get_event ---------------------------------------------------- .. code-block:: lua response = schedule_client:get_event(request) if response.isError then -- エラー処理 -- print(response.statusCode) print(response.errorMessage) else -- 正常処理 -- print(response.result) end 開催中のイベントを取得します Request ---------------------------------------------------- .. include:: control/GetEventRequest.rst Response ---------------------------------------------------- .. include:: control/GetEventResult.rst ---------------------------------------------------- get_event_by_user_id ---------------------------------------------------- .. code-block:: lua response = schedule_client:get_event_by_user_id(request) if response.isError then -- エラー処理 -- print(response.statusCode) print(response.errorMessage) else -- 正常処理 -- print(response.result) end 開催中のイベントを取得します Request ---------------------------------------------------- .. include:: control/GetEventByUserIdRequest.rst Response ---------------------------------------------------- .. include:: control/GetEventByUserIdResult.rst ---------------------------------------------------- get_event_master ---------------------------------------------------- .. code-block:: lua response = schedule_client:get_event_master(request) if response.isError then -- エラー処理 -- print(response.statusCode) print(response.errorMessage) else -- 正常処理 -- print(response.result) end イベントマスターを取得します Request ---------------------------------------------------- .. include:: control/GetEventMasterRequest.rst Response ---------------------------------------------------- .. include:: control/GetEventMasterResult.rst ---------------------------------------------------- get_schedule ---------------------------------------------------- .. code-block:: lua response = schedule_client:get_schedule(request) if response.isError then -- エラー処理 -- print(response.statusCode) print(response.errorMessage) else -- 正常処理 -- print(response.result) end スケジュールを取得します Request ---------------------------------------------------- .. include:: control/GetScheduleRequest.rst Response ---------------------------------------------------- .. include:: control/GetScheduleResult.rst ---------------------------------------------------- get_schedule_status ---------------------------------------------------- .. code-block:: lua response = schedule_client:get_schedule_status(request) if response.isError then -- エラー処理 -- print(response.statusCode) print(response.errorMessage) else -- 正常処理 -- print(response.result) end スケジュールの状態を取得します Request ---------------------------------------------------- .. include:: control/GetScheduleStatusRequest.rst Response ---------------------------------------------------- .. include:: control/GetScheduleStatusResult.rst ---------------------------------------------------- get_trigger ---------------------------------------------------- .. code-block:: lua response = schedule_client:get_trigger(request) if response.isError then -- エラー処理 -- print(response.statusCode) print(response.errorMessage) else -- 正常処理 -- print(response.result) end トリガーを取得します Request ---------------------------------------------------- .. include:: control/GetTriggerRequest.rst Response ---------------------------------------------------- .. include:: control/GetTriggerResult.rst ---------------------------------------------------- pull_trigger ---------------------------------------------------- .. code-block:: lua response = schedule_client:pull_trigger(request) if response.isError then -- エラー処理 -- print(response.statusCode) print(response.errorMessage) else -- 正常処理 -- print(response.result) end トリガーを引きます Request ---------------------------------------------------- .. include:: control/PullTriggerRequest.rst Response ---------------------------------------------------- .. include:: control/PullTriggerResult.rst ---------------------------------------------------- update_current_event_master ---------------------------------------------------- .. code-block:: lua response = schedule_client:update_current_event_master(request) if response.isError then -- エラー処理 -- print(response.statusCode) print(response.errorMessage) else -- 正常処理 -- print(response.result) end イベントマスターを更新します Request ---------------------------------------------------- .. include:: control/UpdateCurrentEventMasterRequest.rst Response ---------------------------------------------------- .. include:: control/UpdateCurrentEventMasterResult.rst ---------------------------------------------------- update_event_master ---------------------------------------------------- .. code-block:: lua response = schedule_client:update_event_master(request) if response.isError then -- エラー処理 -- print(response.statusCode) print(response.errorMessage) else -- 正常処理 -- print(response.result) end イベントマスターを更新します Request ---------------------------------------------------- .. include:: control/UpdateEventMasterRequest.rst Response ---------------------------------------------------- .. include:: control/UpdateEventMasterResult.rst ---------------------------------------------------- update_schedule ---------------------------------------------------- .. code-block:: lua response = schedule_client:update_schedule(request) if response.isError then -- エラー処理 -- print(response.statusCode) print(response.errorMessage) else -- 正常処理 -- print(response.result) end スケジュールを更新します Request ---------------------------------------------------- .. include:: control/UpdateScheduleRequest.rst Response ---------------------------------------------------- .. include:: control/UpdateScheduleResult.rst Model ==================================================== ---------------------------------------------------- Schedule ---------------------------------------------------- .. include:: model/Schedule.rst ---------------------------------------------------- EventMaster ---------------------------------------------------- .. include:: model/EventMaster.rst ---------------------------------------------------- Trigger ---------------------------------------------------- .. include:: model/Trigger.rst ---------------------------------------------------- Event ---------------------------------------------------- .. include:: model/Event.rst