Skip to main content

SetChannelPolicyInput

Set the per-app channel creation/membership policy (app-admin only).

input SetChannelPolicyInput {
appId: BigInt!
creationPolicy: String
defaultMembershipPolicy: String
maxMembers: Int
maxGroupsPerUser: Int
}

Fields

SetChannelPolicyInput.appId ● BigInt! non-null scalar

The app (tenant) whose channel policy to set.

SetChannelPolicyInput.creationPolicy ● String scalar

admin | member | anyone. Who may create channels in this app.

SetChannelPolicyInput.defaultMembershipPolicy ● String scalar

open | request | invite | admin. Default membership policy for new channels.

SetChannelPolicyInput.maxMembers ● Int scalar

Optional cap on members per channel (null = unlimited).

SetChannelPolicyInput.maxGroupsPerUser ● Int scalar

Optional cap on how many channels a single user may belong to (null = unlimited).

Member Of

setChannelPolicy mutation