self.remove
- Sacha Parisot (Unlicensed)
self.remove only removes members that need removing. Removing non-existent members has no effect. Removing all members from a group does not delete the group. To delete a group, use self.delete.
Removing no members (sending an empty members list) has no effect on the group, but still forces an update of the group configuration object in the feedback channel. This “trick” can be used to request a group’s current member configuration, similar to empty empty value assignments.
Group Add Actions
A member is removed from an existing group with self.remove. Remove takes an argument object carrying a list of members to be removed.
Group remove argument objects:
Field Name | Type | Description |
apply | Boolean | (Optional) apply tracks the value that was most recently assigned through the group. If such a value is on file, and if apply: true, that most recent value will be re-applied to the group after the self.add or self.remove action completes. |
provision | Boolean | (Optional) Provisions group when members change. Defaults to true. |
members | List of member topics | List of group members. Example: |