Package com.dropbox.core.v2.team

Class MemberAddArg.Builder

java.lang.Object

com.dropbox.core.v2.team.MemberAddArgBase.Builder

com.dropbox.core.v2.team.MemberAddArg.Builder

Enclosing class:

MemberAddArg

public static class MemberAddArg.Builder
extends MemberAddArgBase.Builder

Builder for MemberAddArg.

Field Summary

Fields

Modifier and Type	Field	Description
protected AdminTier	role

Fields inherited from class com.dropbox.core.v2.team.MemberAddArgBase.Builder

isDirectoryRestricted, memberEmail, memberExternalId, memberGivenName, memberPersistentId, memberSurname, sendWelcomeEmail

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder(String memberEmail)

Method Summary

Modifier and Type	Method	Description
MemberAddArg	build()	Builds an instance of MemberAddArg configured with this builder's values
MemberAddArg.Builder	withIsDirectoryRestricted(Boolean isDirectoryRestricted)	Set value for optional field.
MemberAddArg.Builder	withMemberExternalId(String memberExternalId)	Set value for optional field.
MemberAddArg.Builder	withMemberGivenName(String memberGivenName)	Set value for optional field.
MemberAddArg.Builder	withMemberPersistentId(String memberPersistentId)	Set value for optional field.
MemberAddArg.Builder	withMemberSurname(String memberSurname)	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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

role

protected AdminTier role

Constructor Details

Builder

protected Builder(String memberEmail)

Method Details

withRole

public MemberAddArg.Builder withRole(AdminTier role)

Set value for optional field.

If left unset or set to null, defaults to AdminTier.MEMBER_ONLY.

Parameters:

role - Must not be null. Defaults to AdminTier.MEMBER_ONLY when set to null.

Returns:

this builder

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

withMemberGivenName

public MemberAddArg.Builder withMemberGivenName(String memberGivenName)

Set value for optional field.

Overrides:

withMemberGivenName in class MemberAddArgBase.Builder

Parameters:

memberGivenName - Member's first name. Must have length of at most 50 and match pattern "[^/:?*<>\"|]*".

Returns:

this builder

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

withMemberSurname

public MemberAddArg.Builder withMemberSurname(String memberSurname)

Set value for optional field.

Overrides:

withMemberSurname in class MemberAddArgBase.Builder

Parameters:

memberSurname - Member's last name. Must have length of at most 50 and match pattern "[^/:?*<>\"|]*".

Returns:

this builder

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

withMemberExternalId

public MemberAddArg.Builder withMemberExternalId(String memberExternalId)

Set value for optional field.

Overrides:

withMemberExternalId in class MemberAddArgBase.Builder

Parameters:

memberExternalId - External ID for member. Must have length of at most 64.

Returns:

this builder

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

withMemberPersistentId

public MemberAddArg.Builder withMemberPersistentId(String memberPersistentId)

Set value for optional field.

Overrides:

withMemberPersistentId in class MemberAddArgBase.Builder

Parameters:

memberPersistentId - Persistent ID for member. This field is only available to teams using persistent ID SAML configuration.

Returns:

this builder

withSendWelcomeEmail

public MemberAddArg.Builder withSendWelcomeEmail(Boolean sendWelcomeEmail)

Set value for optional field.

If left unset or set to null, defaults to true.

Overrides:

withSendWelcomeEmail in class MemberAddArgBase.Builder

Parameters:

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.

Returns:

this builder

withIsDirectoryRestricted

public MemberAddArg.Builder withIsDirectoryRestricted(Boolean isDirectoryRestricted)

Set value for optional field.

Overrides:

withIsDirectoryRestricted in class MemberAddArgBase.Builder

Parameters:

isDirectoryRestricted - Whether a user is directory restricted.

Returns:

this builder

build

public MemberAddArg build()

Builds an instance of MemberAddArg configured with this builder's values

Overrides:

build in class MemberAddArgBase.Builder

Returns:

new instance of MemberAddArg