To get full access to the Kademi Hub existing customers can login here, or new customers can register here.
Attaches a group to an email job or an SMS job as an audience, so everyone in the group is a recipient of that job. The same row can instead mark the group as an exclusion, in which case its members must not be sent the message even if another rule selects them. Exactly one of the email job or the SMS job is set, and deleting the row detaches it from the job it belonged to.
Group: Database Entities
Implements: Serializable, Relational
Properties
| Property | Returns | Description |
|---|---|---|
| exclusion | Boolean | Whether this group is excluded rather than included. True means members of the group must not be sent the message. Null means it was never set, which is treated as not excluded. |
| id | long | Database identifier for this recipient row, assigned when it is first saved. |
| job | BaseEmailJob | The email job this group is a recipient of. Null when the row belongs to an SMS job instead, and loaded lazily. |
| recipient | Group | The group whose members are the audience described by this row. Never null, and loaded lazily. |
| safeExclusion | boolean | Null safe form of the exclusion flag, reading an unset value as not excluded. Use this rather than the raw flag when deciding whether to send. |
| smsJob | GroupSmsJob | The SMS job this group is a recipient of. Null when the row belongs to an email job instead. |
Methods
getId()
Returns: long
Database identifier for this recipient row, assigned when it is first saved.
getJob()
Returns: BaseEmailJob
The email job this group is a recipient of. Null when the row belongs to an SMS job instead, and loaded lazily.
getRecipient()
Returns: Group
The group whose members are the audience described by this row. Never null, and loaded lazily.
isExclusion()
Returns: Boolean
Whether this group is excluded rather than included. True means members of the group must not be sent the message. Null means it was never set, which is treated as not excluded.
getSmsJob()
Returns: GroupSmsJob
The SMS job this group is a recipient of. Null when the row belongs to an email job instead.
getSafeExclusion()
Returns: boolean
Null safe form of the exclusion flag, reading an unset value as not excluded. Use this rather than the raw flag when deciding whether to send.
© 2025 Kademi Ltd