Skip to content

UserCollaborateRoomModifyRequest

Bases: OCIRequest

Request to modify room settings for a specific Project Room or My Room. Request to modify room settings for a specific Instant Room is responded with an ErrorResponse. The roomSchedule parameter is applicable for Project Room only. If the roomSchedule parameter is specified in the request to modify My Room, the request will be failed. 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_fast/commands/commands.py 
105677
105678
105679
105680
105681
105682
105683
105684
105685
105686
105687
105688
105689
105690
105691
105692
105693
105694
105695
105696
105697
105698
105699
105700
105701
105702
105703
105704
105705
105706
105707
105708
105709
105710
105711
105712
105713
105714
105715
105716
105717
105718
105719
105720
105721
105722
105723
105724
@dataclass(kw_only=True)
class UserCollaborateRoomModifyRequest(OCIRequest):
    """Request to modify room settings for a specific Project Room or My Room.
        Request to modify room settings for a specific Instant Room is responded
        with an ErrorResponse. The roomSchedule parameter is applicable for
        Project Room only. If the roomSchedule parameter is specified in the
        request to modify My Room, the request will be failed.
        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_fast/commands/base_command.py 
115
116
117
118
119
class ErrorResponse(OCIResponse):
    errorCode: Optional[int] = None
    summary: str
    summaryEnglish: str
    detail: Optional[str] = None

Bases: OCIResponse

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

Bases: OCIResponse

Source code in src/mercury_ocip_fast/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_fast.client import Client
from mercury_ocip_fast.commands import UserCollaborateRoomModifyRequest

client = Client()

command = UserCollaborateRoomModifyRequest(
    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_fast.client import Client

client = Client()

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

print(response)