Offers one group as an optional subscription to the members of another group. A profile who is a member of the attached-to group may choose to join the optin group, and the message is the wording shown next to that choice. The row itself records only the offer, not whether anyone accepted it, which is held as ordinary group membership.
Group: Database Entities
Implements: Serializable
Properties
| Property | Returns | Description |
|---|---|---|
| attachedToGroup | Group | The group whose members are offered this opt-in. Anyone who is a member of this group sees the offer to join the optin group. |
| id | long | Database identifier for this opt-in offer, assigned when the row is first saved. |
| message | String | Wording shown to the user beside the opt-in choice, explaining what they are agreeing to. Free text of up to 2000 characters and required. |
| optinGroup | Group | The group a profile joins when they accept this opt-in. Accepting creates an ordinary membership of this group, so removing the membership is how someone opts back out. |
Methods
getId()
Returns: long
Database identifier for this opt-in offer, assigned when the row is first saved.
getAttachedToGroup()
Returns: Group
The group whose members are offered this opt-in. Anyone who is a member of this group sees the offer to join the optin group.
getOptinGroup()
Returns: Group
The group a profile joins when they accept this opt-in. Accepting creates an ordinary membership of this group, so removing the membership is how someone opts back out.
getMessage()
Returns: String
Wording shown to the user beside the opt-in choice, explaining what they are agreeing to. Free text of up to 2000 characters and required.