Skip to content

ChannelGroupPoke

Samuel Grant edited this page Jun 27, 2020 · 2 revisions

Remarks

Pokes active clients of all users belonging to a specific channel's channel group

Notes:

  1. If a user in the target channel's channel group has four active connections to the server, they will get four pokes
  2. IsSuccess will return true correctly when the status struct has been overridden at the end of this function in versions >= v1.0.1

Signature

Params

Name Type Description
cgid int64 The target channel group ID
cid int64 The target channel ID
msg string The message to be sent to clients of the target server group

Returns

Type Description
*status Non standard Query Response (see below)
error
{
   Code int = -1
   Message string = fmt.Sprintf("%v%% of clients successfully poked (%v failed)", ((attempted-failed)/attempted)*100, failed)
}

Example

qres, err := client.ChannelGroupPoke(cgid, cid, "Unescaped message string")
if err != nil {
  // Handle error or rejected server query 
}

Clone this wiki locally