Update ChannelIdBuild reference doc. (#899)

heroiclabs · Aug 19, 2022 · e81d148 · e81d148
1 parent 89d2b68
commit e81d148
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 3 deletions.
diff --git a/server/runtime_go_nakama.go b/server/runtime_go_nakama.go
@@ -3884,7 +3884,7 @@ func (n *RuntimeGoNakamaModule) ChannelMessagesList(ctx context.Context, channel
 // @param ctx(type=context.Context) The context object represents information about the server and requester.
 // @param senderId(type=string) UserID of the message sender (when applicable). An empty string defaults to the system user.
 // @param target(type=string) Can be the room name, group identifier, or another username.
-// @param chanType(type=runtime.ChannelType) The type of channel, for example group or direct.
+// @param chanType(type=runtime.ChannelType) The type of channel, either Room (1), Direct (2), or Group (3).
 // @return channelId(string) The generated ID representing a channel.
 // @return error(error) An optional error value if an error occurred.
 func (n *RuntimeGoNakamaModule) ChannelIdBuild(ctx context.Context, senderId, target string, chanType runtime.ChannelType) (string, error) {

diff --git a/server/runtime_javascript_nakama.go b/server/runtime_javascript_nakama.go
@@ -7931,7 +7931,7 @@ func (n *runtimeJavascriptNakamaModule) channelMessagesList(r *goja.Runtime) fun
 // @summary Create a channel identifier to be used in other runtime calls. Does not create a channel.
 // @param senderId(type=string) UserID of the message sender (when applicable). Defaults to the system user if void.
 // @param target(type=string) Can be the room name, group identifier, or another username.
-// @param chanType(type=nkruntime.ChannelType) The type of channel, for example group or direct.
+// @param chanType(type=nkruntime.ChannelType) The type of channel, either Room (1), Direct (2), or Group (3).
 // @return channelId(string) The generated ID representing a channel.
 // @return error(error) An optional error value if an error occurred.
 func (n *runtimeJavascriptNakamaModule) channelIdBuild(r *goja.Runtime) func(goja.FunctionCall) goja.Value {

diff --git a/server/runtime_lua_nakama.go b/server/runtime_lua_nakama.go
@@ -9515,7 +9515,7 @@ func (n *RuntimeLuaNakamaModule) channelMessagesList(l *lua.LState) int {
 // @summary Create a channel identifier to be used in other runtime calls. Does not create a channel.
 // @param senderId(type=string) UserID of the message sender (when applicable). An empty string defaults to the system user.
 // @param target(type=string) Can be the room name, group identifier, or another username.
-// @param chanType(type=int) The type of channel, for example group or direct.
+// @param chanType(type=int) The type of channel, either Room (1), Direct (2), or Group (3).
 // @return channelId(string) The generated ID representing a channel.
 // @return error(error) An optional error value if an error occurred.
 func (n *RuntimeLuaNakamaModule) channelIdBuild(l *lua.LState) int {