java.lang.Object
- com.slack.api.methods.request.admin.users.AdminUsersInviteRequest

All Implemented Interfaces:

SlackApiRequest
```
public class AdminUsersInviteRequest
extends Object
implements SlackApiRequest
```
https://api.slack.com/methods/admin.users.invite

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class AdminUsersInviteRequest.AdminUsersInviteRequestBuilder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static AdminUsersInviteRequest.AdminUsersInviteRequestBuilder`	`builder()`
`protected boolean`	`canEqual(Object other)`
`boolean`	`equals(Object o)`
`List<String>`	`getChannelIds()`	A comma-separated list of channel_ids for this user to join.
`String`	`getCustomMessage()`	An optional message to send to the user in the invite email.
`String`	`getEmail()`	The email address of the person to invite.
`Boolean`	`getEmailPasswordPolicyEnabled()`	Allow invited user to sign in via email and password.
`String`	`getGuestExpirationTs()`	Timestamp when guest account should be disabled.
`String`	`getRealName()`	Full name of the user.
`String`	`getTeamId()`	Workspace Id
`String`	`getToken()`	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`	`isRestricted()`	Is this user a multi-channel guest user? (default: false)
`boolean`	`isUltraRestricted()`	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`	`setEmail(String email)`	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`	`setTeamId(String teamId)`	Workspace Id
`void`	`setToken(String token)`	Authentication token bearing required scopes.
`void`	`setUltraRestricted(boolean isUltraRestricted)`	Is this user a single channel guest user? (default: false)
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - builder
```
public static AdminUsersInviteRequest.AdminUsersInviteRequestBuilder builder()
```
  - getToken
```
public String getToken()
```
    Authentication token bearing required scopes.
    
    Specified by:
    
    getToken in interface SlackApiRequest
    
    Returns:
    
    token string value or null
  - getChannelIds
```
public List<String> getChannelIds()
```
    A comma-separated list of channel_ids for this user to join. At least one channel is required.
  - getEmail
```
public String getEmail()
```
    The email address of the person to invite.
  - getTeamId
```
public String getTeamId()
```
    Workspace Id
  - getCustomMessage
```
public String getCustomMessage()
```
    An optional message to send to the user in the invite email.
  - getEmailPasswordPolicyEnabled
```
public Boolean 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
```
public String 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
```
public String 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
```
public void setToken(String token)
```
    Authentication token bearing required scopes.
    
    Specified by:
    
    setToken in interface SlackApiRequest
  - setChannelIds
```
public void setChannelIds(List<String> channelIds)
```
    A comma-separated list of channel_ids for this user to join. At least one channel is required.
  - setEmail
```
public void setEmail(String email)
```
    The email address of the person to invite.
  - setTeamId
```
public void setTeamId(String teamId)
```
    Workspace Id
  - setCustomMessage
```
public void setCustomMessage(String customMessage)
```
    An optional message to send to the user in the invite email.
  - setEmailPasswordPolicyEnabled
```
public void setEmailPasswordPolicyEnabled(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)
  - setGuestExpirationTs
```
public void setGuestExpirationTs(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.
  - 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
```
public void setRealName(String realName)
```
    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
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - canEqual
```
protected boolean canEqual(Object other)
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class AdminUsersInviteRequest

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

builder

getToken

getChannelIds

getEmail

getTeamId

getCustomMessage

getEmailPasswordPolicyEnabled

getGuestExpirationTs

isRestricted

isUltraRestricted

getRealName

isResend

setToken

setChannelIds

setEmail

setTeamId

setCustomMessage

setEmailPasswordPolicyEnabled

setGuestExpirationTs

setRestricted

setUltraRestricted

setRealName

setResend

equals

canEqual

hashCode

toString