UserCollaborateProjectRoomGetRequest

Bases: OCIRequest

Request collaborate room settings for a project room. The request fails when requesting collaborate room settings for instant rooms or My Room. The response is either UserCollaboratProjectRoomGetResponse or ErrorResponse.

Attributes:

user_id (str):

room_id (str):

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

@dataclass(kw_only=True)
class UserCollaborateProjectRoomGetRequest(OCIRequest):
    """Request collaborate room settings for a project room.
        The request fails when requesting collaborate room settings for instant rooms or My Room.
        The response is either UserCollaboratProjectRoomGetResponse 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_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 UserCollaborateProjectRoomGetRequest

client = Client()

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

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

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

print(response)