UserCollaborateProjectRoomAddRequest

Bases: OCIRequest

Request to add collaborate project room. The response is either a UserCollaborateProjectRoomAddResponse or an ErrorResponse.

Attributes:

user_id (str):

room_name (str):

attendee_notification (str):

end_collaborate_room_session_on_owner_exit (bool):

owner_required (bool):

room_schedule (CollaborateRoomSchedule):

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

@dataclass(kw_only=True)
class UserCollaborateProjectRoomAddRequest(OCIRequest):
    """Request to add collaborate project room.
        The response is either a UserCollaborateProjectRoomAddResponse or an ErrorResponse.

    Attributes:

        user_id (str):

        room_name (str):

        attendee_notification (str):

        end_collaborate_room_session_on_owner_exit (bool):

        owner_required (bool):

        room_schedule (CollaborateRoomSchedule):

    """

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

    room_name: str = field(metadata={"alias": "roomName"})

    attendee_notification: str = field(metadata={"alias": "attendeeNotification"})

    end_collaborate_room_session_on_owner_exit: bool = field(
        metadata={"alias": "endCollaborateRoomSessionOnOwnerExit"}
    )

    owner_required: bool = field(metadata={"alias": "ownerRequired"})

    room_schedule: CollaborateRoomSchedule = field(metadata={"alias": "roomSchedule"})

Responses

Bases: OCIDataResponse

Response to UserCollaborateProjectRoomAddRequest.

Attributes:

room_id (str):

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

@dataclass(kw_only=True)
class UserCollaborateProjectRoomAddResponse(OCIDataResponse):
    """Response to UserCollaborateProjectRoomAddRequest.

    Attributes:

        room_id (str):

    """

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

Bases: OCIResponse

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

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

Example Usage

from mercury_ocip_fast.client import Client
from mercury_ocip_fast.commands import UserCollaborateProjectRoomAddRequest

client = Client()

command = UserCollaborateProjectRoomAddRequest(
    user_id=...,
    room_name=...,
    attendee_notification=...,
    end_collaborate_room_session_on_owner_exit=...,
    owner_required=...,
    room_schedule=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("UserCollaborateProjectRoomAddRequest",
    user_id=...,
    room_name=...,
    attendee_notification=...,
    end_collaborate_room_session_on_owner_exit=...,
    owner_required=...,
    room_schedule=...,
)

print(response)