UserCollaborateRoomGetRequest

Bases: OCIRequest

Request to get the settings for My Room, Instant Room or Project Room. The roomType and roomName parameters are returned for all rooms. For My room and Project Room, the following parameters are returned: attendeeNotification, endRoomSessionOnOwnerExit and ownerRequired. In addition, the roomSchedule is returned for Project Room and the roomStartTime and roomEndTime are returned for Instant Room. The response is either UserCollaboratetRoomGetResponse or ErrorResponse.

Attributes:

user_id (str):

room_id (str):

Source code in src/mercury_ocip/commands/commands.py

@dataclass(kw_only=True)
class UserCollaborateRoomGetRequest(OCIRequest):
    """Request to get the settings for My Room, Instant Room or Project Room.
      The roomType and roomName parameters are returned for all rooms.
      For My room and Project Room, the following parameters are returned:
      attendeeNotification, endRoomSessionOnOwnerExit and ownerRequired.
      In addition, the roomSchedule is returned for Project Room and
      the roomStartTime and roomEndTime are returned for Instant Room.
        The response is either UserCollaboratetRoomGetResponse or
        ErrorResponse.

    Attributes:

        user_id (str):

        room_id (str):

    """

    user_id: str = field(metadata={"alias": "userId"})

    room_id: str = field(metadata={"alias": "roomId"})

Responses

Bases: OCIResponse

Source code in src/mercury_ocip/commands/base_command.py

class ErrorResponse(OCIResponse):
    errorCode: Optional[int] = None
    summary: str
    summaryEnglish: str
    detail: Optional[str] = None

Example Usage

from mercury_ocip.client import Client
from mercury_ocip.commands import UserCollaborateRoomGetRequest

client = Client()

command = UserCollaborateRoomGetRequest(
    user_id=...,
    room_id=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("UserCollaborateRoomGetRequest",
    user_id=...,
    room_id=...,
)

print(response)