UserCollaborateInstantRoomGetRequest

Bases: OCIRequest

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

Attributes:

user_id (str):

room_id (str):

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

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

client = Client()

command = UserCollaborateInstantRoomGetRequest(
    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("UserCollaborateInstantRoomGetRequest",
    user_id=...,
    room_id=...,
)

print(response)