Skip to content

UserCollaborateProjectRoomModifyRequest

Bases: OCIRequest

Request to modify collaborate room settings for a project room. The request fails when modifying collaborate room settings for instant rooms or My Room. The response is either SuccessResponse or ErrorResponse.

Attributes:

user_id (str):

room_id (str):

room_name (Optional[str]):

attendee_notification (Optional[str]):

end_collaborate_room_session_on_owner_exit (Optional[bool]):

owner_required (Optional[bool]):

room_schedule (Optional[CollaborateRoomSchedule]):
Source code in src/mercury_ocip/commands/commands.py 
105567
105568
105569
105570
105571
105572
105573
105574
105575
105576
105577
105578
105579
105580
105581
105582
105583
105584
105585
105586
105587
105588
105589
105590
105591
105592
105593
105594
105595
105596
105597
105598
105599
105600
105601
105602
105603
105604
105605
105606
105607
105608
105609
105610
105611
@dataclass(kw_only=True)
class UserCollaborateProjectRoomModifyRequest(OCIRequest):
    """Request to modify collaborate room settings for a project room.
        The request fails when modifying collaborate room settings for instant rooms or My Room.
        The response is either SuccessResponse or ErrorResponse.

    Attributes:

        user_id (str):

        room_id (str):

        room_name (Optional[str]):

        attendee_notification (Optional[str]):

        end_collaborate_room_session_on_owner_exit (Optional[bool]):

        owner_required (Optional[bool]):

        room_schedule (Optional[CollaborateRoomSchedule]):

    """

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

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

    room_name: Optional[str] = field(default=None, metadata={"alias": "roomName"})

    attendee_notification: Optional[str] = field(
        default=None, metadata={"alias": "attendeeNotification"}
    )

    end_collaborate_room_session_on_owner_exit: Optional[bool] = field(
        default=None, metadata={"alias": "endCollaborateRoomSessionOnOwnerExit"}
    )

    owner_required: Optional[bool] = field(
        default=None, metadata={"alias": "ownerRequired"}
    )

    room_schedule: Optional[CollaborateRoomSchedule] = field(
        default=None, metadata={"alias": "roomSchedule"}
    )

Responses

Bases: OCIResponse

Source code in src/mercury_ocip/commands/base_command.py 
84
85
class SuccessResponse(OCIResponse):
    pass

Bases: OCIResponse

Source code in src/mercury_ocip/commands/base_command.py 
115
116
117
118
119
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 UserCollaborateProjectRoomModifyRequest

client = Client()

command = UserCollaborateProjectRoomModifyRequest(
    user_id=...,
    room_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.client import Client

client = Client()

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

print(response)