Chat

SyncChannel

core.SyncChannel({query="given group [players]", channelId="3e6e1a3e..."})

DescriptionParametersReturn value

Sync a channel user list with a user query

• object
  • query:String user query such as given group [..]
  • channelId:String Channel id

Mutation result

FindChannelByHandle

core.FindChannelByHandle("some-handle")

DescriptionParametersReturn value

Returns a channel id with a handle

• Handle

Channel ID if found otherwise nil

ConfirmChannel

core.ConfirmChannel({handle="some-handle", ...})

DescriptionParametersReturn value

Create or update a channel using a channel mutation

• object
  • handle:Option[String] - handle is used to identify the channel
  • name:Option[String]
  • status:Option[String]
  • icon:Option[String]
  • color:Option[String]
  • kind:Option[String]
  • linkedChannelId: Option[SafeUuid]
  • editPermission: Option[String]
  • writePermission: Option[String]
  • notificationQuery: Option[String]

Channel ID if found

RetireChannelMessages

core.RetireChannelMessages({handle="some-handle", before="2024-07-01"})

DescriptionParametersReturn value

Retire messages

• object
  • handle:String - handle is used to identify the channel
  • before:Option[String] - optional date with YYYY-MM-DD format; if not provided ALL messages will be retired

Mutation result