UserCollaborateRoomListGetRequest

Bases: OCIRequest

Request the list of collaborate room instances for this specific user. The response is either a UserCollaborateRoomListGetResponse or an ErrorResponse.

Attributes:

user_id (str):

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

@dataclass(kw_only=True)
class UserCollaborateRoomListGetRequest(OCIRequest):
    """Request the list of collaborate room instances for this specific user.
        The response is either a UserCollaborateRoomListGetResponse or an
        ErrorResponse.

    Attributes:

        user_id (str):

    """

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

Responses

Bases: OCIDataResponse

Response to UserCollaborateRoomListGetRequest. Contains a table with column headings : "Room Type", "Name", "Room Id", in a row for each collaborate room instance. Possible values for Room Type column are MyRoom, Project Room and Instant Room.

Attributes:

room_instance_table (OCITable):

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

@dataclass(kw_only=True)
class UserCollaborateRoomListGetResponse(OCIDataResponse):
    """Response to UserCollaborateRoomListGetRequest.
        Contains a table with column headings :  \"Room Type\", \"Name\", \"Room Id\",
        in a row for each collaborate room instance.
        Possible values for Room Type column are MyRoom, Project Room and
        Instant Room.

    Attributes:

        room_instance_table (OCITable):

    """

    room_instance_table: OCITable = field(metadata={"alias": "roomInstanceTable"})

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 UserCollaborateRoomListGetRequest

client = Client()

command = UserCollaborateRoomListGetRequest(
    user_id=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("UserCollaborateRoomListGetRequest",
    user_id=...,
)

print(response)