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

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

Modifier and Type	Method	Description
AdminUsersInviteRequest	build()
AdminUsersInviteRequest.AdminUsersInviteRequestBuilder	channelIds(List<String> channelIds)	A comma-separated list of channel_ids for this user to join.
AdminUsersInviteRequest.AdminUsersInviteRequestBuilder	customMessage(String customMessage)	An optional message to send to the user in the invite email.
AdminUsersInviteRequest.AdminUsersInviteRequestBuilder	email(String email)	The email address of the person to invite.
AdminUsersInviteRequest.AdminUsersInviteRequestBuilder	guestExpirationTs(String guestExpirationTs)	Timestamp when guest account should be disabled.
AdminUsersInviteRequest.AdminUsersInviteRequestBuilder	isRestricted(boolean isRestricted)	Is this user a multi-channel guest user? (default: false)
AdminUsersInviteRequest.AdminUsersInviteRequestBuilder	isUltraRestricted(boolean isUltraRestricted)	Is this user a single channel guest user? (default: false)
AdminUsersInviteRequest.AdminUsersInviteRequestBuilder	realName(String realName)	Full name of the user.
AdminUsersInviteRequest.AdminUsersInviteRequestBuilder	resend(boolean resend)	Allow this invite to be resent in the future if a user has not signed up yet.
AdminUsersInviteRequest.AdminUsersInviteRequestBuilder	teamId(String teamId)	Workspace Id
AdminUsersInviteRequest.AdminUsersInviteRequestBuilder	token(String token)	Authentication token bearing required scopes.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

token

public AdminUsersInviteRequest.AdminUsersInviteRequestBuilder token(String token)

Authentication token bearing required scopes.

Returns:

this.

channelIds

public AdminUsersInviteRequest.AdminUsersInviteRequestBuilder channelIds(List<String> channelIds)

A comma-separated list of channel_ids for this user to join. At least one channel is required.

Returns:

this.

email

public AdminUsersInviteRequest.AdminUsersInviteRequestBuilder email(String email)

The email address of the person to invite.

Returns:

this.

teamId

public AdminUsersInviteRequest.AdminUsersInviteRequestBuilder teamId(String teamId)

Workspace Id

Returns:

this.

customMessage

public AdminUsersInviteRequest.AdminUsersInviteRequestBuilder customMessage(String customMessage)

An optional message to send to the user in the invite email.

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

public AdminUsersInviteRequest.AdminUsersInviteRequestBuilder isRestricted(boolean 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

public AdminUsersInviteRequest.AdminUsersInviteRequestBuilder realName(String realName)

Full name of the user.

Returns:

this.

resend

public AdminUsersInviteRequest.AdminUsersInviteRequestBuilder resend(boolean resend)

Allow this invite to be resent in the future if a user has not signed up yet. (default: false)

Returns:

this.

build

public AdminUsersInviteRequest build()

toString

public String toString()

Overrides:

toString in class Object