Package com.slack.api.methods.request.admin.users

Class AdminUsersInviteRequest

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

  • Method Details

    • builder

      public static AdminUsersInviteRequest.AdminUsersInviteRequestBuilder builder()

    • getToken

      public String getToken()
      Authentication token bearing required scopes.
      Specified by:
      getToken in interface SlackApiRequest

    • 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.

    • 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.

    • 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.

    • 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