com.twilio.rest.fax.v1

Class FaxCreator

java.lang.Object

com.twilio.base.Creator<Fax>

com.twilio.rest.fax.v1.FaxCreator

public class FaxCreator
extends Creator<Fax>

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

Constructor Summary

Constructors

Constructor and Description
FaxCreator(String to, URI mediaUrl) Construct a new FaxCreator.

Method Summary

Modifier and Type	Method and Description
Fax	create(TwilioRestClient client) Make the request to the Twilio API to perform the create.
FaxCreator	setFrom(String from) The phone number to use as the caller id, E.164-formatted.
FaxCreator	setQuality(Fax.Quality quality) The quality setting to use for this fax.
FaxCreator	setSipAuthPassword(String sipAuthPassword) The password to use for authentication when sending to a SIP address..
FaxCreator	setSipAuthUsername(String sipAuthUsername) The username to use for authentication when sending to a SIP address..
FaxCreator	setStatusCallback(String statusCallback) The URL that Twilio will request when the status of the fax changes..
FaxCreator	setStatusCallback(URI statusCallback) The URL that Twilio will request when the status of the fax changes..
FaxCreator	setStoreMedia(Boolean storeMedia) Whether or not to store a copy of the sent media on Twilio's servers for later retrieval (defaults to `true`).

Methods inherited from class com.twilio.base.Creator

create, createAsync, createAsync

Methods inherited from class java.lang.Object

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

Constructor Detail

FaxCreator

public FaxCreator(String to,
                  URI mediaUrl)

Construct a new FaxCreator.

Parameters:

to - The phone number or SIP address to send the fax to

mediaUrl - URL that points to the fax media

Method Detail

setQuality

public FaxCreator setQuality(Fax.Quality quality)

The quality setting to use for this fax. One of `standard`, `fine` or `superfine`..

Parameters:

quality - The quality of this fax

Returns:

this

setStatusCallback

public FaxCreator setStatusCallback(URI statusCallback)

The URL that Twilio will request when the status of the fax changes..

Parameters:

statusCallback - URL for fax status callbacks

Returns:

this

setStatusCallback

public FaxCreator setStatusCallback(String statusCallback)

The URL that Twilio will request when the status of the fax changes..

Parameters:

statusCallback - URL for fax status callbacks

Returns:

this

setFrom

public FaxCreator setFrom(String from)

The phone number to use as the caller id, E.164-formatted. If using a phone number, it must be a Twilio number or a verified outgoing caller id for your account. If sending to a SIP address, this can be any alphanumeric string (plus the characters `+`, `_`, `.`, and `-`) to use in the From header of the SIP request..

Parameters:

from - Twilio number from which to originate the fax

Returns:

this

setSipAuthUsername

public FaxCreator setSipAuthUsername(String sipAuthUsername)

The username to use for authentication when sending to a SIP address..

Parameters:

sipAuthUsername - Username for SIP authentication

Returns:

this

setSipAuthPassword

public FaxCreator setSipAuthPassword(String sipAuthPassword)

The password to use for authentication when sending to a SIP address..

Parameters:

sipAuthPassword - Password for SIP authentication

Returns:

this

setStoreMedia

public FaxCreator setStoreMedia(Boolean storeMedia)

Whether or not to store a copy of the sent media on Twilio's servers for later retrieval (defaults to `true`).

Parameters:

storeMedia - Whether or not to store media

Returns:

this

create

public Fax create(TwilioRestClient client)

Make the request to the Twilio API to perform the create.

Specified by:

create in class Creator<Fax>

Parameters:

client - TwilioRestClient with which to make the request

Returns:

Created Fax