UserCollaborateInstantRoomAddRequest

Bases: OCIRequest

Request to add collaborate instant room. The response is either a UserCollaborateInstantRoomAddResponse or an ErrorResponse.

Attributes:

user_id (str):

room_name (Optional[str]):

use_room_id_as_room_name (Optional[bool]):

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

@dataclass(kw_only=True)
class UserCollaborateInstantRoomAddRequest(OCIRequest):
    """Request to add collaborate instant room.
        The response is either a UserCollaborateInstantRoomAddResponse or an ErrorResponse.

    Attributes:

        user_id (str):

        room_name (Optional[str]):

        use_room_id_as_room_name (Optional[bool]):

    """

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

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

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

Responses

Bases: OCIDataResponse

Response to UserCollaborateInstantRoomAddRequest.

Attributes:

room_id (str):

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

@dataclass(kw_only=True)
class UserCollaborateInstantRoomAddResponse(OCIDataResponse):
    """Response to UserCollaborateInstantRoomAddRequest.

    Attributes:

        room_id (str):

    """

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

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 UserCollaborateInstantRoomAddRequest

client = Client()

command = UserCollaborateInstantRoomAddRequest(
    user_id=...,
    room_name=...,
    use_room_id_as_room_name=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("UserCollaborateInstantRoomAddRequest",
    user_id=...,
    room_name=...,
    use_room_id_as_room_name=...,
)

print(response)