CommunicationRoom Class

Package:
com.azure.communication.rooms.models
Maven Artifact:
com.azure:azure-communication-rooms:1.2.6
  • java.lang.Object
    • com.azure.communication.rooms.models.CommunicationRoom

public final class CommunicationRoom

The CommunicationRoom model.

Constructor Summary

Constructor Description
CommunicationRoom(String roomId, OffsetDateTime validFrom, OffsetDateTime validUntil, OffsetDateTime createdAt)

The default constructor of CommunicationRoom.
CommunicationRoom(String roomId, OffsetDateTime validFrom, OffsetDateTime validUntil, OffsetDateTime createdAt, Boolean pstnDialOutEnabled)

Overloaded constructor of CommunicationRoom.

Method Summary

Modifier and Type Method and Description
OffsetDateTime getCreatedAt()

Get the createdAt property: The timestamp when the room was created at the server.
String getRoomId()

Get the id property: Unique identifier of a room.
OffsetDateTime getValidFrom()

Get the validFrom property: The timestamp from when the room is open for joining.
OffsetDateTime getValidUntil()

Get the validUntil property: The timestamp from when the room can no longer be joined.
Boolean isPstnDialOutEnabled()

Get the pstnDialOutEnabled property: Set this flag to true if, at the time of the call, dial out to a PSTN number is enabled in a particular room.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

CommunicationRoom

public CommunicationRoom(String roomId, OffsetDateTime validFrom, OffsetDateTime validUntil, OffsetDateTime createdAt)

The default constructor of CommunicationRoom.

Parameters:

roomId - Unique identifier of a room. This id is server generated.
validFrom - The timestamp from when the room is open for joining. The timestamp is in RFC3339 format: yyyy-MM-ddTHH:mm:ssZ.
validUntil - The timestamp from when the room can no longer be joined. The timestamp is in RFC3339 format: yyyy-MM-ddTHH:mm:ssZ.
createdAt - The timestamp when the room was created at the server. The timestamp is in RFC3339 format: yyyy-MM-ddTHH:mm:ssZ.

CommunicationRoom

public CommunicationRoom(String roomId, OffsetDateTime validFrom, OffsetDateTime validUntil, OffsetDateTime createdAt, Boolean pstnDialOutEnabled)

Overloaded constructor of CommunicationRoom.

Parameters:

roomId - Unique identifier of a room. This id is server generated.
validFrom - The timestamp from when the room is open for joining. The timestamp is in RFC3339 format: yyyy-MM-ddTHH:mm:ssZ.
validUntil - The timestamp from when the room can no longer be joined. The timestamp is in RFC3339 format: yyyy-MM-ddTHH:mm:ssZ.
createdAt - The timestamp when the room was created at the server. The timestamp is in RFC3339 format: yyyy-MM-ddTHH:mm:ssZ.
pstnDialOutEnabled - Set this flag to true if, at the time of the call, dial out to a PSTN number is enabled in a particular room. By default, this flag is set to false.

Method Details

getCreatedAt

public OffsetDateTime getCreatedAt()

Get the createdAt property: The timestamp when the room was created at the server. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`.

Returns:

the createdAt value.

getRoomId

public String getRoomId()

Get the id property: Unique identifier of a room. This id is server generated.

Returns:

the id value.

getValidFrom

public OffsetDateTime getValidFrom()

Get the validFrom property: The timestamp from when the room is open for joining. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`.

Returns:

the validFrom value.

getValidUntil

public OffsetDateTime getValidUntil()

Get the validUntil property: The timestamp from when the room can no longer be joined. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`.

Returns:

the validUntil value.

isPstnDialOutEnabled

public Boolean isPstnDialOutEnabled()

Get the pstnDialOutEnabled property: Set this flag to true if, at the time of the call, dial out to a PSTN number is enabled in a particular room. By default, this flag is set to false.

Returns:

the pstnDialOutEnabled value.

Applies to