> For the complete documentation index, see [llms.txt](/llms.txt)

# GS2-Inbox スクリプト トリガー リファレンス

拡張スクリプトを呼び出すイベントトリガーのリファレンス



## トリガー

### receiveMessage

メッセージ受信
**関連するメソッド:**
sendMessageByUserId - ユーザーIDを指定してメッセージの送信
receiveGlobalMessage - グローバルメッセージのうちまだ受け取っていないメッセージを受信
receiveGlobalMessageByUserId - ユーザーIDを指定してグローバルメッセージのうちまだ受け取っていないメッセージを受信


#### 同期実行スクリプト

メッセージ受信処理の前に、スクリプトが同期実行されます。

##### Request

| | 型 | 説明 |
| --- | --- | --- |
| namespace | [Namespace](../sdk/#namespace) | ネームスペース |
| message | [Message](../sdk/#message) | メッセージ |

##### Result

|  | 型 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- |
| permit | bool | ✓ |  |  | メッセージ受信 を許可するか |
| overrideMetadata | string |  |  | 0 ~ 4096文字 | 上書きするメタデータ |

##### 実装例


**Lua**
```lua

-- Request
local namespace = args.namespace
local message = args.message

-- Business logic:
local permit = true
local overrideMetadata = ""

-- Result
result = {
  permit=permit,
  overrideMetadata=overrideMetadata
}
```


#### 非同期実行スクリプト

メッセージ受信処理の後に、スクリプトが非同期実行されます。

##### Request

| | 型 | 説明 |
| --- | --- | --- |
| namespace | [Namespace](../sdk/#namespace) | ネームスペース |
| message | [Message](../sdk/#message) | メッセージ |


##### 実装例


**Lua**
```lua

-- Request
local namespace = args.namespace
local message = args.message

-- 非同期スクリプトは通常、API のレスポンスには影響を与えません。
-- ログ出力や分析、外部通知などに使用します。

result = {
}
```


---
  
### readMessage

メッセージ開封
**関連するメソッド:**
readMessage - メッセージを開封


#### 同期実行スクリプト

メッセージ開封処理の前に、スクリプトが同期実行されます。

##### Request

| | 型 | 説明 |
| --- | --- | --- |
| namespace | [Namespace](../sdk/#namespace) | ネームスペース |
| message | [Message](../sdk/#message) | メッセージ |

##### Result

|  | 型 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- |
| permit | bool | ✓ |  |  | メッセージ開封 を許可するか |

##### 実装例


**Lua**
```lua

-- Request
local namespace = args.namespace
local message = args.message

-- Business logic:
local permit = true

-- Result
result = {
  permit=permit
}
```


#### 非同期実行スクリプト

メッセージ開封処理の後に、スクリプトが非同期実行されます。

##### Request

| | 型 | 説明 |
| --- | --- | --- |
| namespace | [Namespace](../sdk/#namespace) | ネームスペース |
| message | [Message](../sdk/#message) | メッセージ |


##### 実装例


**Lua**
```lua

-- Request
local namespace = args.namespace
local message = args.message

-- 非同期スクリプトは通常、API のレスポンスには影響を与えません。
-- ログ出力や分析、外部通知などに使用します。

result = {
}
```


---
  
### deleteMessage

メッセージ削除
**関連するメソッド:**
deleteMessage - メッセージを削除


#### 同期実行スクリプト

メッセージ削除処理の前に、スクリプトが同期実行されます。

##### Request

| | 型 | 説明 |
| --- | --- | --- |
| namespace | [Namespace](../sdk/#namespace) | ネームスペース |
| message | [Message](../sdk/#message) | メッセージ |

##### Result

|  | 型 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- |
| permit | bool | ✓ |  |  | メッセージ削除 を許可するか |

##### 実装例


**Lua**
```lua

-- Request
local namespace = args.namespace
local message = args.message

-- Business logic:
local permit = true

-- Result
result = {
  permit=permit
}
```


#### 非同期実行スクリプト

メッセージ削除処理の後に、スクリプトが非同期実行されます。

##### Request

| | 型 | 説明 |
| --- | --- | --- |
| namespace | [Namespace](../sdk/#namespace) | ネームスペース |
| message | [Message](../sdk/#message) | メッセージ |


##### 実装例


**Lua**
```lua

-- Request
local namespace = args.namespace
local message = args.message

-- 非同期スクリプトは通常、API のレスポンスには影響を与えません。
-- ログ出力や分析、外部通知などに使用します。

result = {
}
```


---