Package com.auth0.json.mgmt.guardian

Class EnrollmentTicket

java.lang.Object

com.auth0.json.mgmt.guardian.EnrollmentTicket

public class EnrollmentTicket
extends Object

Class that represents an Auth0 Guardian Enrollment Ticket object. Related to the GuardianEntity entity.

Constructor Summary

Constructors

Constructor	Description
EnrollmentTicket(String userId)	Creates a new instance of the Enrollment Ticket for a given User.
EnrollmentTicket(String userId, Boolean sendEmail)	Creates a new instance of the Enrollment Ticket for a given User, specifying if you want the ticket to also be sent to the user by email.
EnrollmentTicket(String userId, Boolean sendEmail, String email)	Creates a new instance of the Enrollment Ticket for a given User, specifying if you want the ticket to also be sent to the specified email address.

Method Summary

Modifier and Type	Method	Description
String	getEmail()	Getter for the email to which the ticket will be sent.
String	getTicketId()	Getter for the ticket id.
String	getTicketUrl()	Getter for the ticket url.
String	getUserId()	Getter for the id of the User this ticket was made for.
void	setEmail(String email)	Deprecated. use the constructor instead
void	setSendEmail(Boolean sendEmail)	Deprecated. use the constructor instead
void	setUserId(String userId)	Deprecated. use the constructor instead
Boolean	willSendEmail()	Whether to send and email for enrollment or not.

Methods inherited from class java.lang.Object

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

Constructor Details

EnrollmentTicket

public EnrollmentTicket(String userId)

Creates a new instance of the Enrollment Ticket for a given User.

Parameters:

userId - the user id

EnrollmentTicket

public EnrollmentTicket(String userId,
 Boolean sendEmail)

Creates a new instance of the Enrollment Ticket for a given User, specifying if you want the ticket to also be sent to the user by email.

Parameters:

userId - the user id

sendEmail - whether the ticket should also be sent to the user by email

EnrollmentTicket

public EnrollmentTicket(String userId,
 Boolean sendEmail,
 String email)

Creates a new instance of the Enrollment Ticket for a given User, specifying if you want the ticket to also be sent to the specified email address.

Parameters:

userId - the user id

sendEmail - whether the ticket should also be sent to the user by email

email - the email where the ticket will be sent.

Method Details

getUserId

public String getUserId()

Getter for the id of the User this ticket was made for.

Returns:

the user id.

setUserId

@Deprecated
public void setUserId(String userId)

Deprecated.

use the constructor instead

Setter for the id of the user this ticket is meant to.

Parameters:

userId - the user id to set.

willSendEmail

public Boolean willSendEmail()

Whether to send and email for enrollment or not.

Returns:

true is this ticket will send an email upon enrollment, false otherwise.

setSendEmail

@Deprecated
public void setSendEmail(Boolean sendEmail)

Deprecated.

use the constructor instead

Sets whether to send and email for enrollment or not.

Parameters:

sendEmail - whether this ticket will send an email upon enrollment or not.

getEmail

public String getEmail()

Getter for the email to which the ticket will be sent.

Returns:

the email.

setEmail

@Deprecated
public void setEmail(String email)

Deprecated.

use the constructor instead

Setter for the email to which the ticket will be sent.

Parameters:

email - the email to sent the ticket to.

getTicketId

public String getTicketId()

Getter for the ticket id.

Returns:

the ticket id.

getTicketUrl

public String getTicketUrl()

Getter for the ticket url.

Returns:

the ticket url.