==================================================== GS2-Inbox ==================================================== **Create Client** .. code-block:: lua inbox_client = client('inbox') .. contents:: 目次 :local: :depth: 2 Method ==================================================== ---------------------------------------------------- create_inbox ---------------------------------------------------- .. code-block:: lua response = inbox_client:create_inbox(request) if response.isError then -- エラー処理 -- print(response.statusCode) print(response.errorMessage) else -- 正常処理 -- print(response.result) end 受信ボックスを新規作成します Request ---------------------------------------------------- .. include:: control/CreateInboxRequest.rst Response ---------------------------------------------------- .. include:: control/CreateInboxResult.rst ---------------------------------------------------- delete_inbox ---------------------------------------------------- .. code-block:: lua response = inbox_client:delete_inbox(request) if response.isError then -- エラー処理 -- print(response.statusCode) print(response.errorMessage) else -- 正常処理 -- print(response.result) end 受信ボックスを削除します Request ---------------------------------------------------- .. include:: control/DeleteInboxRequest.rst Response ---------------------------------------------------- None ---------------------------------------------------- delete_message ---------------------------------------------------- .. code-block:: lua response = inbox_client:delete_message(request) if response.isError then -- エラー処理 -- print(response.statusCode) print(response.errorMessage) else -- 正常処理 -- print(response.result) end メッセージを削除します - 消費クオータ: 10 Request ---------------------------------------------------- .. include:: control/DeleteMessageRequest.rst Response ---------------------------------------------------- None ---------------------------------------------------- delete_messages ---------------------------------------------------- .. code-block:: lua response = inbox_client:delete_messages(request) if response.isError then -- エラー処理 -- print(response.statusCode) print(response.errorMessage) else -- 正常処理 -- print(response.result) end 複数のメッセージをまとめて削除します - 消費クオータ: 削除するメッセージの数 * 10 Request ---------------------------------------------------- .. include:: control/DeleteMessagesRequest.rst Response ---------------------------------------------------- None ---------------------------------------------------- describe_inbox ---------------------------------------------------- .. code-block:: lua response = inbox_client:describe_inbox(request) if response.isError then -- エラー処理 -- print(response.statusCode) print(response.errorMessage) else -- 正常処理 -- print(response.result) end 受信ボックスの一覧を取得します Request ---------------------------------------------------- .. include:: control/DescribeInboxRequest.rst Response ---------------------------------------------------- .. include:: control/DescribeInboxResult.rst ---------------------------------------------------- describe_message ---------------------------------------------------- .. code-block:: lua response = inbox_client:describe_message(request) if response.isError then -- エラー処理 -- print(response.statusCode) print(response.errorMessage) else -- 正常処理 -- print(response.result) end 受信メッセージの一覧を取得します - 消費クオータ: 50件あたり5 Request ---------------------------------------------------- .. include:: control/DescribeMessageRequest.rst Response ---------------------------------------------------- .. include:: control/DescribeMessageResult.rst ---------------------------------------------------- describe_service_class ---------------------------------------------------- .. code-block:: lua response = inbox_client:describe_service_class(request) if response.isError then -- エラー処理 -- print(response.statusCode) print(response.errorMessage) else -- 正常処理 -- print(response.result) end サービスクラスの一覧を取得します Request ---------------------------------------------------- .. include:: control/DescribeServiceClassRequest.rst Response ---------------------------------------------------- .. include:: control/DescribeServiceClassResult.rst ---------------------------------------------------- get_inbox ---------------------------------------------------- .. code-block:: lua response = inbox_client:get_inbox(request) if response.isError then -- エラー処理 -- print(response.statusCode) print(response.errorMessage) else -- 正常処理 -- print(response.result) end 受信ボックスを取得します Request ---------------------------------------------------- .. include:: control/GetInboxRequest.rst Response ---------------------------------------------------- .. include:: control/GetInboxResult.rst ---------------------------------------------------- get_inbox_status ---------------------------------------------------- .. code-block:: lua response = inbox_client:get_inbox_status(request) if response.isError then -- エラー処理 -- print(response.statusCode) print(response.errorMessage) else -- 正常処理 -- print(response.result) end 受信ボックスの状態を取得します Request ---------------------------------------------------- .. include:: control/GetInboxStatusRequest.rst Response ---------------------------------------------------- .. include:: control/GetInboxStatusResult.rst ---------------------------------------------------- get_message ---------------------------------------------------- .. code-block:: lua response = inbox_client:get_message(request) if response.isError then -- エラー処理 -- print(response.statusCode) print(response.errorMessage) else -- 正常処理 -- print(response.result) end メッセージを取得します - 消費クオータ: 5 Request ---------------------------------------------------- .. include:: control/GetMessageRequest.rst Response ---------------------------------------------------- .. include:: control/GetMessageResult.rst ---------------------------------------------------- read_message ---------------------------------------------------- .. code-block:: lua response = inbox_client:read_message(request) if response.isError then -- エラー処理 -- print(response.statusCode) print(response.errorMessage) else -- 正常処理 -- print(response.result) end メッセージを開封します - 消費クオータ: 10 Request ---------------------------------------------------- .. include:: control/ReadMessageRequest.rst Response ---------------------------------------------------- .. include:: control/ReadMessageResult.rst ---------------------------------------------------- read_messages ---------------------------------------------------- .. code-block:: lua response = inbox_client:read_messages(request) if response.isError then -- エラー処理 -- print(response.statusCode) print(response.errorMessage) else -- 正常処理 -- print(response.result) end 複数のメッセージをまとめて開封します 連携用URLと複数メッセージの開封処理を同時に利用する場合は、200レスポンスを応答すると、GS2側では指定されたすべてのメッセージを開封したことにします。 200 以外のステータスコードを応答する場合はレスポンスボディにJSON形式で、 "success" というパラメータに開封に成功したメッセージIDのリストを返す必要があります。 success に指定されたメッセージIDのみ開封成功処理を行い、BadGateway(502)応答を返します。 BadGateway(502) のレスポンスボディには、コールバックで返された値がそのまま含まれます。 例えば、メッセージにアイテムを添付されていたが、一部アイテムが所有できる上限を超えていたため開封できなかった。という場合 success にはアイテムを付与できたメッセージIDのみを応答し、reason など任意のパラメータでアイテムの所持上限を迎えたため メッセージID hoge のメッセージは開封に失敗した。というようなレスポンスを返すことでクライアントにも開封に失敗した理由を伝えることができます。 - 消費クオータ: 開封するメッセージの数 * 10 Request ---------------------------------------------------- .. include:: control/ReadMessagesRequest.rst Response ---------------------------------------------------- .. include:: control/ReadMessagesResult.rst ---------------------------------------------------- send_message ---------------------------------------------------- .. code-block:: lua response = inbox_client:send_message(request) if response.isError then -- エラー処理 -- print(response.statusCode) print(response.errorMessage) else -- 正常処理 -- print(response.result) end メッセージを送信します - 消費クオータ: 10 Request ---------------------------------------------------- .. include:: control/SendMessageRequest.rst Response ---------------------------------------------------- .. include:: control/SendMessageResult.rst ---------------------------------------------------- update_inbox ---------------------------------------------------- .. code-block:: lua response = inbox_client:update_inbox(request) if response.isError then -- エラー処理 -- print(response.statusCode) print(response.errorMessage) else -- 正常処理 -- print(response.result) end 受信ボックスを更新します Request ---------------------------------------------------- .. include:: control/UpdateInboxRequest.rst Response ---------------------------------------------------- .. include:: control/UpdateInboxResult.rst Model ==================================================== ---------------------------------------------------- Message ---------------------------------------------------- .. include:: model/Message.rst ---------------------------------------------------- Inbox ---------------------------------------------------- .. include:: model/Inbox.rst