com.twilio.rest.proxy.v1.service

Class SessionCreator

java.lang.Object

com.twilio.base.Creator<Session>

com.twilio.rest.proxy.v1.service.SessionCreator

public class SessionCreator
extends Creator<Session>

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

Constructor Summary

Constructors

Constructor and Description
SessionCreator(String pathServiceSid) Construct a new SessionCreator.

Method Summary

Modifier and Type	Method and Description
Session	create(TwilioRestClient client) Make the request to the Twilio API to perform the create.
SessionCreator	setDateExpiry(ZonedDateTime dateExpiry) The ISO 8601 date when the Session should expire.
SessionCreator	setFailOnParticipantConflict(Boolean failOnParticipantConflict) [Experimental] For accounts with the ProxyAllowParticipantConflict account flag, setting to true enables per-request opt-in to allowing Proxy to reject a Session create (with Participants) request that could cause the same Identifier/ProxyIdentifier pair to be active in multiple Sessions.
SessionCreator	setMode(Session.Mode mode) The Mode of the Session.
SessionCreator	setParticipants(List<Map<String,Object>> participants) The Participant objects to include in the new session..
SessionCreator	setParticipants(Map<String,Object> participants) The Participant objects to include in the new session..
SessionCreator	setStatus(Session.Status status) The initial status of the Session.
SessionCreator	setTtl(Integer ttl) The time, in seconds, when the session will expire.
SessionCreator	setUniqueName(String uniqueName) An application-defined string that uniquely identifies the resource.

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

SessionCreator

public SessionCreator(String pathServiceSid)

Construct a new SessionCreator.

Parameters:

pathServiceSid - The SID of the parent Service resource

Method Detail

setUniqueName

public SessionCreator setUniqueName(String uniqueName)

An application-defined string that uniquely identifies the resource. This value must be 191 characters or fewer in length and be unique. **This value should not have PII.**.

Parameters:

uniqueName - An application-defined string that uniquely identifies the resource

Returns:

this

setDateExpiry

public SessionCreator setDateExpiry(ZonedDateTime dateExpiry)

The ISO 8601 date when the Session should expire. If this is value is present, it overrides the `ttl` value..

Parameters:

dateExpiry - The ISO 8601 date when the Session should expire

Returns:

this

setTtl

public SessionCreator setTtl(Integer ttl)

The time, in seconds, when the session will expire. The time is measured from the last Session create or the Session's last Interaction..

Parameters:

ttl - When the session will expire

Returns:

this

setMode

public SessionCreator setMode(Session.Mode mode)

The Mode of the Session. Can be: `message-only`, `voice-only`, or `voice-and-message` and the default value is `voice-and-message`..

Parameters:

mode - The Mode of the Session

Returns:

this

setStatus

public SessionCreator setStatus(Session.Status status)

The initial status of the Session. Can be: `open`, `in-progress`, `closed`, `failed`, or `unknown`. The default is `open` on create..

Parameters:

status - Session status

Returns:

this

setParticipants

public SessionCreator setParticipants(List<Map<String,Object>> participants)

The Participant objects to include in the new session..

Parameters:

participants - The Participant objects to include in the new session

Returns:

this

setParticipants

public SessionCreator setParticipants(Map<String,Object> participants)

The Participant objects to include in the new session..

Parameters:

participants - The Participant objects to include in the new session

Returns:

this

setFailOnParticipantConflict

public SessionCreator setFailOnParticipantConflict(Boolean failOnParticipantConflict)

[Experimental] For accounts with the ProxyAllowParticipantConflict account flag, setting to true enables per-request opt-in to allowing Proxy to reject a Session create (with Participants) request that could cause the same Identifier/ProxyIdentifier pair to be active in multiple Sessions. Depending on the context, this could be a 409 error (Twilio error code 80623) or a 400 error (Twilio error code 80604). If not provided, requests will be allowed to succeed and a Debugger notification (80802) will be emitted. Having multiple, active Participants with the same Identifier/ProxyIdentifier pair causes calls and messages from affected Participants to be routed incorrectly. Please note, the default behavior for accounts without the ProxyAllowParticipantConflict flag is to reject the request as described. This will eventually be the default for all accounts..

Parameters:

failOnParticipantConflict - An experimental parameter to override the ProxyAllowParticipantConflict account flag on a per-request basis.

Returns:

this

create

public Session create(TwilioRestClient client)

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

Specified by:

create in class Creator<Session>

Parameters:

client - TwilioRestClient with which to make the request

Returns:

Created Session