Class AdminUsersInviteRequest.AdminUsersInviteRequestBuilder
java.lang.Object
com.slack.api.methods.request.admin.users.AdminUsersInviteRequest.AdminUsersInviteRequestBuilder
- Enclosing class:
- AdminUsersInviteRequest
public static class AdminUsersInviteRequest.AdminUsersInviteRequestBuilder extends Object
-
Method Summary
-
Method Details
-
token
Authentication token bearing required scopes.- Returns:
this
.
-
channelIds
A comma-separated list of channel_ids for this user to join. At least one channel is required.- Returns:
this
.
-
email
The email address of the person to invite.- Returns:
this
.
-
teamId
Workspace Id- Returns:
this
.
-
customMessage
An optional message to send to the user in the invite email.- Returns:
this
.
-
emailPasswordPolicyEnabled
public AdminUsersInviteRequest.AdminUsersInviteRequestBuilder emailPasswordPolicyEnabled(Boolean emailPasswordPolicyEnabled)Allow invited user to sign in via email and password. Only available for Enterprise Grid teams via admin invite. (As this parameter does not have the default value, we don't use the primitive value type)- Returns:
this
.
-
guestExpirationTs
public AdminUsersInviteRequest.AdminUsersInviteRequestBuilder guestExpirationTs(String guestExpirationTs)Timestamp when guest account should be disabled. Only include this timestamp if you inviting a guest user and you want their account to expire on a certain date.- Returns:
this
.
-
isRestricted
Is this user a multi-channel guest user? (default: false)- Returns:
this
.
-
isUltraRestricted
public AdminUsersInviteRequest.AdminUsersInviteRequestBuilder isUltraRestricted(boolean isUltraRestricted)Is this user a single channel guest user? (default: false)- Returns:
this
.
-
realName
Full name of the user.- Returns:
this
.
-
resend
Allow this invite to be resent in the future if a user has not signed up yet. (default: false)- Returns:
this
.
-
build
-
toString
-