Class MemberAddArg

    • Constructor Detail

      • MemberAddArg

        public MemberAddArg​(java.lang.String memberEmail,
                            java.lang.String memberGivenName,
                            java.lang.String memberSurname,
                            java.lang.String memberExternalId,
                            java.lang.String memberPersistentId,
                            boolean sendWelcomeEmail,
                            java.lang.Boolean isDirectoryRestricted,
                            AdminTier role)
        Use newBuilder(java.lang.String) to create instances of this class without specifying values for all optional fields.
        Parameters:
        memberEmail - Must have length of at most 255, match pattern " ^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\\.[A-Za-z]{2,15}$", and not be null.
        memberGivenName - Member's first name. Must have length of at most 100 and match pattern "[^/:?*<>\"|]*".
        memberSurname - Member's last name. Must have length of at most 100 and match pattern "[^/:?*<>\"|]*".
        memberExternalId - External ID for member. Must have length of at most 64.
        memberPersistentId - Persistent ID for member. This field is only available to teams using persistent ID SAML configuration.
        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.
        isDirectoryRestricted - Whether a user is directory restricted.
        role - Must not be null.
        Throws:
        java.lang.IllegalArgumentException - If any argument does not meet its preconditions.
      • MemberAddArg

        public MemberAddArg​(java.lang.String memberEmail)
        None

        The default values for unset fields will be used.

        Parameters:
        memberEmail - Must have length of at most 255, match pattern " ^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\\.[A-Za-z]{2,15}$", and not be null.
        Throws:
        java.lang.IllegalArgumentException - If any argument does not meet its preconditions.
    • Method Detail

      • getMemberEmail

        public java.lang.String getMemberEmail()
        Overrides:
        getMemberEmail in class MemberAddArgBase
        Returns:
        value for this field, never null.
      • getMemberGivenName

        public java.lang.String getMemberGivenName()
        Member's first name.
        Overrides:
        getMemberGivenName in class MemberAddArgBase
        Returns:
        value for this field, or null if not present.
      • getMemberSurname

        public java.lang.String getMemberSurname()
        Member's last name.
        Overrides:
        getMemberSurname in class MemberAddArgBase
        Returns:
        value for this field, or null if not present.
      • getMemberExternalId

        public java.lang.String getMemberExternalId()
        External ID for member.
        Overrides:
        getMemberExternalId in class MemberAddArgBase
        Returns:
        value for this field, or null if not present.
      • getMemberPersistentId

        public java.lang.String getMemberPersistentId()
        Persistent ID for member. This field is only available to teams using persistent ID SAML configuration.
        Overrides:
        getMemberPersistentId in class MemberAddArgBase
        Returns:
        value for this field, or null if not present.
      • getSendWelcomeEmail

        public boolean getSendWelcomeEmail()
        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.
        Overrides:
        getSendWelcomeEmail in class MemberAddArgBase
        Returns:
        value for this field, or null if not present. Defaults to true.
      • getIsDirectoryRestricted

        public java.lang.Boolean getIsDirectoryRestricted()
        Whether a user is directory restricted.
        Overrides:
        getIsDirectoryRestricted in class MemberAddArgBase
        Returns:
        value for this field, or null if not present.
      • getRole

        public AdminTier getRole()
        Returns:
        value for this field, or null if not present. Defaults to AdminTier.MEMBER_ONLY.
      • newBuilder

        public static MemberAddArg.Builder newBuilder​(java.lang.String memberEmail)
        Returns a new builder for creating an instance of this class.
        Parameters:
        memberEmail - Must have length of at most 255, match pattern " ^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\\.[A-Za-z]{2,15}$", and not be null.
        Returns:
        builder for this class.
        Throws:
        java.lang.IllegalArgumentException - If any argument does not meet its preconditions.
      • toStringMultiline

        public java.lang.String toStringMultiline()
        Returns a String representation of this object formatted for easier readability.

        The returned String may contain newlines.

        Overrides:
        toStringMultiline in class MemberAddArgBase
        Returns:
        Formatted, multiline String representation of this object