UserCollaborateRoomIDRegenerateRequest

Bases: OCIRequest

Request to regenerate collaborate room id for MyRoom and project room. The request fails when requesting to regenerate room ID for an instant room. The response is either a UserCollaborateRoomIDRegenerateResponse or an ErrorResponse.

Attributes:

user_id (str):

room_id (str):

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

@dataclass(kw_only=True)
class UserCollaborateRoomIDRegenerateRequest(OCIRequest):
    """Request to regenerate collaborate room id for MyRoom and project room.
        The request fails when requesting to regenerate room ID for an instant room.
        The response is either a UserCollaborateRoomIDRegenerateResponse or an
        ErrorResponse.

    Attributes:

        user_id (str):

        room_id (str):

    """

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

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

Responses

Bases: OCIDataResponse

Response to UserCollaborateRoomIDRegenerateRequest.

Attributes:

room_id (str):

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

@dataclass(kw_only=True)
class UserCollaborateRoomIDRegenerateResponse(OCIDataResponse):
    """Response to UserCollaborateRoomIDRegenerateRequest.

    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 UserCollaborateRoomIDRegenerateRequest

client = Client()

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

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

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

print(response)