Package com.twilio.rest.video.v1
Class Room
- java.lang.Object
-
- com.twilio.base.Resource
-
- com.twilio.rest.video.v1.Room
-
- All Implemented Interfaces:
Serializable
public class Room extends Resource
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Room.RoomStatus
static class
Room.RoomType
static class
Room.VideoCodec
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static RoomCreator
creator()
Create a RoomCreator to execute create.boolean
equals(Object o)
static RoomFetcher
fetcher(String pathSid)
Create a RoomFetcher to execute fetch.static Room
fromJson(InputStream json, com.fasterxml.jackson.databind.ObjectMapper objectMapper)
Converts a JSON InputStream into a Room object using the provided ObjectMapper.static Room
fromJson(String json, com.fasterxml.jackson.databind.ObjectMapper objectMapper)
Converts a JSON String into a Room object using the provided ObjectMapper.String
getAccountSid()
Returns The The unique ID of the Account associated with this Room..org.joda.time.DateTime
getDateCreated()
Returns The The date that this resource was created, given as a UTC ISO 8601 Timestamp..org.joda.time.DateTime
getDateUpdated()
Returns The The date that this resource was last updated, given as a UTC ISO 8601 Timestamp..Integer
getDuration()
Returns The The duration of the Room in seconds..Boolean
getEnableTurn()
Returns The Enable Twilio's Network Traversal TURN service..org.joda.time.DateTime
getEndTime()
Returns The The end time of the Room, given as a UTC ISO 8601 Timestamp..Map<String,String>
getLinks()
Returns The The links.Integer
getMaxParticipants()
Returns The Maximum number of concurrent Participants allowed in the Room..String
getMediaRegion()
Returns The Region for the media server in Group Rooms..Boolean
getRecordParticipantsOnConnect()
Returns The Start recording when Participants connect..String
getSid()
Returns The A system-generated 34-character string that uniquely identifies this resource..Room.RoomStatus
getStatus()
Returns The A string representing the status of the Room..URI
getStatusCallback()
Returns The A URL that Twilio sends asynchronous webhook requests to on every Room event..HttpMethod
getStatusCallbackMethod()
Returns The HTTP method Twilio should use when requesting the above URL..Room.RoomType
getType()
Returns The Type of Room, either peer-to-peer, group-small or group..String
getUniqueName()
Returns The A developer-supplied Name of the Room..URI
getUrl()
Returns The The absolute URL for this resource..List<Room.VideoCodec>
getVideoCodecs()
Returns The The video_codecs.int
hashCode()
static RoomReader
reader()
Create a RoomReader to execute read.String
toString()
static RoomUpdater
updater(String pathSid, Room.RoomStatus status)
Create a RoomUpdater to execute update.
-
-
-
Method Detail
-
fetcher
public static RoomFetcher fetcher(String pathSid)
Create a RoomFetcher to execute fetch.- Parameters:
pathSid
- The Room Sid or name that uniquely identifies this resource.- Returns:
- RoomFetcher capable of executing the fetch
-
creator
public static RoomCreator creator()
Create a RoomCreator to execute create.- Returns:
- RoomCreator capable of executing the create
-
reader
public static RoomReader reader()
Create a RoomReader to execute read.- Returns:
- RoomReader capable of executing the read
-
updater
public static RoomUpdater updater(String pathSid, Room.RoomStatus status)
Create a RoomUpdater to execute update.- Parameters:
pathSid
- The Room Sid or name that uniquely identifies this resource.status
- Set to completed to end the Room.- Returns:
- RoomUpdater capable of executing the update
-
fromJson
public static Room fromJson(String json, com.fasterxml.jackson.databind.ObjectMapper objectMapper)
Converts a JSON String into a Room object using the provided ObjectMapper.- Parameters:
json
- Raw JSON StringobjectMapper
- Jackson ObjectMapper- Returns:
- Room object represented by the provided JSON
-
fromJson
public static Room fromJson(InputStream json, com.fasterxml.jackson.databind.ObjectMapper objectMapper)
Converts a JSON InputStream into a Room object using the provided ObjectMapper.- Parameters:
json
- Raw JSON InputStreamobjectMapper
- Jackson ObjectMapper- Returns:
- Room object represented by the provided JSON
-
getSid
public final String getSid()
Returns The A system-generated 34-character string that uniquely identifies this resource..- Returns:
- A system-generated 34-character string that uniquely identifies this resource.
-
getStatus
public final Room.RoomStatus getStatus()
Returns The A string representing the status of the Room..- Returns:
- A string representing the status of the Room.
-
getDateCreated
public final org.joda.time.DateTime getDateCreated()
Returns The The date that this resource was created, given as a UTC ISO 8601 Timestamp..- Returns:
- The date that this resource was created, given as a UTC ISO 8601 Timestamp.
-
getDateUpdated
public final org.joda.time.DateTime getDateUpdated()
Returns The The date that this resource was last updated, given as a UTC ISO 8601 Timestamp..- Returns:
- The date that this resource was last updated, given as a UTC ISO 8601 Timestamp.
-
getAccountSid
public final String getAccountSid()
Returns The The unique ID of the Account associated with this Room..- Returns:
- The unique ID of the Account associated with this Room.
-
getEnableTurn
public final Boolean getEnableTurn()
Returns The Enable Twilio's Network Traversal TURN service..- Returns:
- Enable Twilio's Network Traversal TURN service.
-
getUniqueName
public final String getUniqueName()
Returns The A developer-supplied Name of the Room..- Returns:
- A developer-supplied Name of the Room.
-
getStatusCallback
public final URI getStatusCallback()
Returns The A URL that Twilio sends asynchronous webhook requests to on every Room event..- Returns:
- A URL that Twilio sends asynchronous webhook requests to on every Room event.
-
getStatusCallbackMethod
public final HttpMethod getStatusCallbackMethod()
Returns The HTTP method Twilio should use when requesting the above URL..- Returns:
- HTTP method Twilio should use when requesting the above URL.
-
getEndTime
public final org.joda.time.DateTime getEndTime()
Returns The The end time of the Room, given as a UTC ISO 8601 Timestamp..- Returns:
- The end time of the Room, given as a UTC ISO 8601 Timestamp.
-
getDuration
public final Integer getDuration()
Returns The The duration of the Room in seconds..- Returns:
- The duration of the Room in seconds.
-
getType
public final Room.RoomType getType()
Returns The Type of Room, either peer-to-peer, group-small or group..- Returns:
- Type of Room, either peer-to-peer, group-small or group.
-
getMaxParticipants
public final Integer getMaxParticipants()
Returns The Maximum number of concurrent Participants allowed in the Room..- Returns:
- Maximum number of concurrent Participants allowed in the Room.
-
getRecordParticipantsOnConnect
public final Boolean getRecordParticipantsOnConnect()
Returns The Start recording when Participants connect..- Returns:
- Start recording when Participants connect.
-
getVideoCodecs
public final List<Room.VideoCodec> getVideoCodecs()
Returns The The video_codecs.- Returns:
- The video_codecs
-
getMediaRegion
public final String getMediaRegion()
Returns The Region for the media server in Group Rooms..- Returns:
- Region for the media server in Group Rooms.
-
getUrl
public final URI getUrl()
Returns The The absolute URL for this resource..- Returns:
- The absolute URL for this resource.
-
-