com.approveapi

Class CreatePromptRequest

java.lang.Object

com.approveapi.CreatePromptRequest

public class CreatePromptRequest
extends Object

CreatePromptRequest

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERIALIZED_NAME_APPROVE_TEXT
static String	SERIALIZED_NAME_BODY
static String	SERIALIZED_NAME_EXPIRES_IN
static String	SERIALIZED_NAME_LONG_POLL
static String	SERIALIZED_NAME_METADATA
static String	SERIALIZED_NAME_REJECT_TEXT
static String	SERIALIZED_NAME_TITLE
static String	SERIALIZED_NAME_USER

Constructor Summary

Constructors

Constructor and Description
CreatePromptRequest()

Method Summary

Modifier and Type	Method and Description
CreatePromptRequest	approveText(String approveText)
CreatePromptRequest	body(String body)
boolean	equals(Object o)
CreatePromptRequest	expiresIn(BigDecimal expiresIn)
String	getApproveText() The approve action text.
String	getBody() The body of the approval request to show the user.
BigDecimal	getExpiresIn() The number of seconds until this request can no longer be answered.
Boolean	getLongPoll() If true, the request waits (long-polls) until the user responds to the prompt or more than 10 minutes pass.
PromptMetadata	getMetadata() Get metadata
String	getRejectText() The reject action text.
String	getTitle() The title of an approval request.
String	getUser() The user to send the approval request to.
int	hashCode()
CreatePromptRequest	longPoll(Boolean longPoll)
CreatePromptRequest	metadata(PromptMetadata metadata)
CreatePromptRequest	rejectText(String rejectText)
void	setApproveText(String approveText)
void	setBody(String body)
void	setExpiresIn(BigDecimal expiresIn)
void	setLongPoll(Boolean longPoll)
void	setMetadata(PromptMetadata metadata)
void	setRejectText(String rejectText)
void	setTitle(String title)
void	setUser(String user)
CreatePromptRequest	title(String title)
String	toString()
CreatePromptRequest	user(String user)

Methods inherited from class java.lang.Object

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

Field Detail

SERIALIZED_NAME_BODY

public static final String SERIALIZED_NAME_BODY

See Also:

Constant Field Values

SERIALIZED_NAME_TITLE

public static final String SERIALIZED_NAME_TITLE

See Also:

Constant Field Values

SERIALIZED_NAME_REJECT_TEXT

public static final String SERIALIZED_NAME_REJECT_TEXT

See Also:

Constant Field Values

SERIALIZED_NAME_EXPIRES_IN

public static final String SERIALIZED_NAME_EXPIRES_IN

See Also:

Constant Field Values

SERIALIZED_NAME_LONG_POLL

public static final String SERIALIZED_NAME_LONG_POLL

See Also:

Constant Field Values

SERIALIZED_NAME_USER

public static final String SERIALIZED_NAME_USER

See Also:

Constant Field Values

SERIALIZED_NAME_APPROVE_TEXT

public static final String SERIALIZED_NAME_APPROVE_TEXT

See Also:

Constant Field Values

SERIALIZED_NAME_METADATA

public static final String SERIALIZED_NAME_METADATA

See Also:

Constant Field Values

Constructor Detail

CreatePromptRequest

public CreatePromptRequest()

Method Detail

body

public CreatePromptRequest body(String body)

getBody

public String getBody()

The body of the approval request to show the user.

Returns:

body

setBody

public void setBody(String body)

title

public CreatePromptRequest title(String title)

getTitle

public String getTitle()

The title of an approval request. Defaults to an empty string.

Returns:

title

setTitle

public void setTitle(String title)

rejectText

public CreatePromptRequest rejectText(String rejectText)

getRejectText

public String getRejectText()

The reject action text. Defaults to 'Reject'.

Returns:

rejectText

setRejectText

public void setRejectText(String rejectText)

expiresIn

public CreatePromptRequest expiresIn(BigDecimal expiresIn)

getExpiresIn

public BigDecimal getExpiresIn()

The number of seconds until this request can no longer be answered.

Returns:

expiresIn

setExpiresIn

public void setExpiresIn(BigDecimal expiresIn)

longPoll

public CreatePromptRequest longPoll(Boolean longPoll)

getLongPoll

public Boolean getLongPoll()

If true, the request waits (long-polls) until the user responds to the prompt or more than 10 minutes pass. Defaults to false.

Returns:

longPoll

setLongPoll

public void setLongPoll(Boolean longPoll)

user

public CreatePromptRequest user(String user)

getUser

public String getUser()

The user to send the approval request to. Can be either an email address or a phone number.

Returns:

user

setUser

public void setUser(String user)

approveText

public CreatePromptRequest approveText(String approveText)

getApproveText

public String getApproveText()

The approve action text. Defaults to 'Approve'.

Returns:

approveText

setApproveText

public void setApproveText(String approveText)

metadata

public CreatePromptRequest metadata(PromptMetadata metadata)

getMetadata

public PromptMetadata getMetadata()

Get metadata

Returns:

metadata

setMetadata

public void setMetadata(PromptMetadata metadata)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object