UserCollaborateInstantRoomParametersModifyRequest

Bases: OCIRequest

Request to modify collaborate instant room settings. The response is either SuccessResponse or ErrorResponse.

Attributes:

user_id (str):

attendee_notification (Optional[str]):

end_collaborate_room_session_on_owner_exit (Optional[bool]):

owner_required (Optional[bool]):

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

@dataclass(kw_only=True)
class UserCollaborateInstantRoomParametersModifyRequest(OCIRequest):
    """Request to modify collaborate instant room settings.
        The response is either SuccessResponse or ErrorResponse.

    Attributes:

        user_id (str):

        attendee_notification (Optional[str]):

        end_collaborate_room_session_on_owner_exit (Optional[bool]):

        owner_required (Optional[bool]):

    """

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

    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"}
    )

Responses

Bases: OCIResponse

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

class SuccessResponse(OCIResponse):
    pass

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 UserCollaborateInstantRoomParametersModifyRequest

client = Client()

command = UserCollaborateInstantRoomParametersModifyRequest(
    user_id=...,
    attendee_notification=...,
    end_collaborate_room_session_on_owner_exit=...,
    owner_required=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("UserCollaborateInstantRoomParametersModifyRequest",
    user_id=...,
    attendee_notification=...,
    end_collaborate_room_session_on_owner_exit=...,
    owner_required=...,
)

print(response)