Class AdminUsersInviteRequest
java.lang.Object
com.slack.api.methods.request.admin.users.AdminUsersInviteRequest
- All Implemented Interfaces:
SlackApiRequest
https://api.slack.com/methods/admin.users.invite
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
protected boolean
boolean
A comma-separated list of channel_ids for this user to join.An optional message to send to the user in the invite email.getEmail()
The email address of the person to invite.Allow invited user to sign in via email and password.Timestamp when guest account should be disabled.Full name of the user.Workspace IdgetToken()
Authentication token bearing required scopes.int
hashCode()
boolean
isResend()
Allow this invite to be resent in the future if a user has not signed up yet.boolean
Is this user a multi-channel guest user? (default: false)boolean
Is this user a single channel guest user? (default: false)void
setChannelIds
(List<String> channelIds) A comma-separated list of channel_ids for this user to join.void
setCustomMessage
(String customMessage) An optional message to send to the user in the invite email.void
The email address of the person to invite.void
setEmailPasswordPolicyEnabled
(Boolean emailPasswordPolicyEnabled) Allow invited user to sign in via email and password.void
setGuestExpirationTs
(String guestExpirationTs) Timestamp when guest account should be disabled.void
setRealName
(String realName) Full name of the user.void
setResend
(boolean resend) Allow this invite to be resent in the future if a user has not signed up yet.void
setRestricted
(boolean isRestricted) Is this user a multi-channel guest user? (default: false)void
Workspace Idvoid
Authentication token bearing required scopes.void
setUltraRestricted
(boolean isUltraRestricted) Is this user a single channel guest user? (default: false)toString()
-
Method Details
-
builder
-
getToken
Authentication token bearing required scopes.- Specified by:
getToken
in interfaceSlackApiRequest
- Returns:
- token string value or null
-
getChannelIds
A comma-separated list of channel_ids for this user to join. At least one channel is required. -
getEmail
The email address of the person to invite. -
getTeamId
Workspace Id -
getCustomMessage
An optional message to send to the user in the invite email. -
getEmailPasswordPolicyEnabled
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) -
getGuestExpirationTs
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. -
isRestricted
public boolean isRestricted()Is this user a multi-channel guest user? (default: false) -
isUltraRestricted
public boolean isUltraRestricted()Is this user a single channel guest user? (default: false) -
getRealName
Full name of the user. -
isResend
public boolean isResend()Allow this invite to be resent in the future if a user has not signed up yet. (default: false) -
setToken
Authentication token bearing required scopes.- Specified by:
setToken
in interfaceSlackApiRequest
-
setChannelIds
A comma-separated list of channel_ids for this user to join. At least one channel is required. -
setEmail
The email address of the person to invite. -
setTeamId
Workspace Id -
setCustomMessage
An optional message to send to the user in the invite email. -
setEmailPasswordPolicyEnabled
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) -
setGuestExpirationTs
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. -
setRestricted
public void setRestricted(boolean isRestricted) Is this user a multi-channel guest user? (default: false) -
setUltraRestricted
public void setUltraRestricted(boolean isUltraRestricted) Is this user a single channel guest user? (default: false) -
setRealName
Full name of the user. -
setResend
public void setResend(boolean resend) Allow this invite to be resent in the future if a user has not signed up yet. (default: false) -
equals
-
canEqual
-
hashCode
public int hashCode() -
toString
-