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

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

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



## トリガー

### createRoom

ルーム作成
**関連するメソッド:**
createRoom - ルームを作成


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

ルーム作成処理の前に、スクリプトが同期実行されます。

##### Request

| | 型 | 説明 |
| --- | --- | --- |
| namespace | [Namespace](../sdk/#namespace) | ネームスペース |
| room | [Room](../sdk/#room) | ルーム |

##### Result

|  | 型 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- |
| permit | bool | ✓ |  |  | ルーム作成を許可するか |

##### 実装例


**Lua**
```lua

-- Request
local namespace = args.namespace
local room = args.room

-- Business logic:
local permit = true

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


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

ルーム作成処理の後に、スクリプトが非同期実行されます。

##### Request

| | 型 | 説明 |
| --- | --- | --- |
| namespace | [Namespace](../sdk/#namespace) | ネームスペース |
| room | [Room](../sdk/#room) | ルーム |


##### 実装例


**Lua**
```lua

-- Request
local namespace = args.namespace
local room = args.room

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

result = {
}
```


---
  
### deleteRoom

ルーム削除
**関連するメソッド:**
deleteRoom - ルームを削除


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

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

##### Request

| | 型 | 説明 |
| --- | --- | --- |
| namespace | [Namespace](../sdk/#namespace) | ネームスペース |
| room | [Room](../sdk/#room) | ルーム |

##### Result

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

##### 実装例


**Lua**
```lua

-- Request
local namespace = args.namespace
local room = args.room

-- Business logic:
local permit = true

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


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

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

##### Request

| | 型 | 説明 |
| --- | --- | --- |
| namespace | [Namespace](../sdk/#namespace) | ネームスペース |
| room | [Room](../sdk/#room) | ルーム |


##### 実装例


**Lua**
```lua

-- Request
local namespace = args.namespace
local room = args.room

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

result = {
}
```


---
  
### postMessage

メッセージ投稿
**関連するメソッド:**
post - メッセージを投稿
postByUserId - ユーザーIDを指定してメッセージを投稿


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

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

##### Request

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

##### Result

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

##### 実装例


**Lua**
```lua

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

-- Business logic:
local permit = true

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


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

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

##### Request

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


##### 実装例


**Lua**
```lua

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

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

result = {
}
```


---
  
### subscribeRoom

ルーム購読
**関連するメソッド:**
subscribe - ルームを購読
subscribeByUserId - ユーザーIDを指定してルームを購読


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

ルーム購読処理の前に、スクリプトが同期実行されます。

##### Request

| | 型 | 説明 |
| --- | --- | --- |
| namespace | [Namespace](../sdk/#namespace) | ネームスペース |
| room | [Room](../sdk/#room) | ルーム |
| subscribe | [Subscribe](../sdk/#subscribe) | 購読 |

##### Result

|  | 型 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- |
| permit | bool | ✓ |  |  | ルーム購読を許可するか |

##### 実装例


**Lua**
```lua

-- Request
local namespace = args.namespace
local room = args.room
local subscribe = args.subscribe

-- Business logic:
local permit = true

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


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

ルーム購読処理の後に、スクリプトが非同期実行されます。

##### Request

| | 型 | 説明 |
| --- | --- | --- |
| namespace | [Namespace](../sdk/#namespace) | ネームスペース |
| room | [Room](../sdk/#room) | ルーム |
| subscribe | [Subscribe](../sdk/#subscribe) | 購読 |


##### 実装例


**Lua**
```lua

-- Request
local namespace = args.namespace
local room = args.room
local subscribe = args.subscribe

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

result = {
}
```


---
  
### unsubscribeRoom

ルーム購読解除
**関連するメソッド:**
unsubscribe - ルーム購読を解除
unsubscribeByUserId - ユーザーIDを指定してルーム購読を解除


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

ルーム購読解除処理の前に、スクリプトが同期実行されます。

##### Request

| | 型 | 説明 |
| --- | --- | --- |
| namespace | [Namespace](../sdk/#namespace) | ネームスペース |
| room | [Room](../sdk/#room) | ルーム |
| subscribe | [Subscribe](../sdk/#subscribe) | 購読 |

##### Result

|  | 型 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- |
| permit | bool | ✓ |  |  | ルーム購読解除を許可するか |

##### 実装例


**Lua**
```lua

-- Request
local namespace = args.namespace
local room = args.room
local subscribe = args.subscribe

-- Business logic:
local permit = true

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


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

ルーム購読解除処理の後に、スクリプトが非同期実行されます。

##### Request

| | 型 | 説明 |
| --- | --- | --- |
| namespace | [Namespace](../sdk/#namespace) | ネームスペース |
| room | [Room](../sdk/#room) | ルーム |
| subscribe | [Subscribe](../sdk/#subscribe) | 購読 |


##### 実装例


**Lua**
```lua

-- Request
local namespace = args.namespace
local room = args.room
local subscribe = args.subscribe

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

result = {
}
```


---