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 java.lang.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

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

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Method Details

    • builder

      public static AdminUsersInviteRequest.AdminUsersInviteRequestBuilder builder()

    • getToken

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

    • getChannelIds

      public java.util.List<java.lang.String> getChannelIds()
      A comma-separated list of channel_ids for this user to join. At least one channel is required.

    • getEmail

      public java.lang.String getEmail()
      The email address of the person to invite.

    • getTeamId

      public java.lang.String getTeamId()
      Workspace Id

    • getCustomMessage

      public java.lang.String getCustomMessage()
      An optional message to send to the user in the invite email.

    • getEmailPasswordPolicyEnabled

      public java.lang.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 java.lang.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 java.lang.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​(java.lang.String token)
      Authentication token bearing required scopes.

    • setChannelIds

      public void setChannelIds​(java.util.List<java.lang.String> channelIds)
      A comma-separated list of channel_ids for this user to join. At least one channel is required.

    • setEmail

      public void setEmail​(java.lang.String email)
      The email address of the person to invite.

    • setTeamId

      public void setTeamId​(java.lang.String teamId)
      Workspace Id

    • setCustomMessage

      public void setCustomMessage​(java.lang.String customMessage)
      An optional message to send to the user in the invite email.

    • setEmailPasswordPolicyEnabled

      public void setEmailPasswordPolicyEnabled​(java.lang.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​(java.lang.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​(java.lang.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​(java.lang.Object o)
      Overrides:
      equals in class java.lang.Object

    • canEqual

      protected boolean canEqual​(java.lang.Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class java.lang.Object

    • toString

      public java.lang.String toString()
      Overrides:
      toString in class java.lang.Object