public static class MemberAddArg.Builder extends Object
MemberAddArg.| Modifier and Type | Field and Description |
|---|---|
protected String |
memberEmail |
protected String |
memberExternalId |
protected String |
memberGivenName |
protected String |
memberSurname |
protected AdminTier |
role |
protected boolean |
sendWelcomeEmail |
| Modifier | Constructor and Description |
|---|---|
protected |
Builder(String memberEmail,
String memberGivenName,
String memberSurname) |
| Modifier and Type | Method and Description |
|---|---|
MemberAddArg |
build()
Builds an instance of
MemberAddArg configured with this
builder's values |
MemberAddArg.Builder |
withMemberExternalId(String memberExternalId)
Set value for optional field.
|
MemberAddArg.Builder |
withRole(AdminTier role)
Set value for optional field.
|
MemberAddArg.Builder |
withSendWelcomeEmail(Boolean sendWelcomeEmail)
Set value for optional field.
|
protected final String memberEmail
protected final String memberGivenName
protected final String memberSurname
protected String memberExternalId
protected boolean sendWelcomeEmail
protected AdminTier role
public MemberAddArg.Builder withMemberExternalId(String memberExternalId)
memberExternalId - External ID for member. Must have length of
at most 64.IllegalArgumentException - If any argument does not meet its
preconditions.public MemberAddArg.Builder withSendWelcomeEmail(Boolean sendWelcomeEmail)
If left unset or set to null, defaults to true.
sendWelcomeEmail - Whether to send a welcome email to the
member. If send_welcome_email is false, no email invitation will
be sent to the user. This may be useful for apps using single
sign-on (SSO) flows for onboarding that want to handle
announcements themselves. Defaults to true when set to
null.public MemberAddArg.Builder withRole(AdminTier role)
If left unset or set to null, defaults to AdminTier.MEMBER_ONLY.
role - Must not be null. Defaults to AdminTier.MEMBER_ONLY when set to null.IllegalArgumentException - If any argument does not meet its
preconditions.public MemberAddArg build()
MemberAddArg configured with this
builder's valuesMemberAddArg