Method: Gs2::Inbox::Client#create_inbox

Defined in:
lib/gs2/inbox/Client.rb

#create_inbox(request) ⇒ Array

受信ボックスを作成

GS2-Inbox を利用するにはまず受信ボックスを作成します。
受信ボックスを作成後、受信ボックスにメッセージを送信することでメッセージを届けることができます。
1つの受信ボックスで、複数のユーザのメッセージを扱うことができますので、ユーザ数分の受信ボックスを作成する必要はありません。

Parameters:

  • request (Array) —

    • name => 受信ボックス名

    • serviceClass => サービスクラス

    • autoDelete => 自動削除設定

    • cooperationUrl => 連携用URL

Returns:

  • (Array) —

    • item

    • inboxId => 受信ボックスID

    • ownerId => オーナーID

    • name => 受信ボックス名

    • serviceClass => サービスクラス

    • autoDelete => 自動削除設定

    • cooperationUrl => 連携用URL

    • createAt => 作成日時



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/gs2/inbox/Client.rb', line 77

def create_inbox(request)
  if not request; raise ArgumentError.new(); end
  body = {}
  if request.has_key?('name'); body['name'] = request['name']; end
  if request.has_key?('serviceClass'); body['serviceClass'] = request['serviceClass']; end
  if request.has_key?('autoDelete'); body['autoDelete'] = request['autoDelete']; end
  if request.has_key?('cooperationUrl'); body['cooperationUrl'] = request['cooperationUrl']; end
  query = {}
  return post(
        'Gs2Inbox', 
        'CreateInbox', 
        @@ENDPOINT, 
        '/inbox',
        body,
        query);
end