Skip to content

SystemCollaborateModifyRequest20sp1V2

Bases: OCIRequest

Modify the system level data associated with collaborate services. The response is either a SuccessResponse or an ErrorResponse.

Attributes:

collaborate_room_id_length (Optional[int]):

instant_room_idle_timeout_seconds (Optional[int]):

collaborate_room_maximum_duration_minutes (Optional[int]):

support_outdial (Optional[bool]):

max_collaborate_room_participants (Optional[int]):

collaborate_active_talker_refresh_interval_seconds (Optional[int]):

terminate_collaborate_after_grace_period (Optional[bool]):

collaborate_grace_period (Optional[CollaborateGracePeriodDuration]):

enable_active_collaborate_notification (Optional[bool]):

collaborate_from_address (Optional[Nillable[str]]):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class SystemCollaborateModifyRequest20sp1V2(OCIRequest):
    """Modify the system level data associated with collaborate services.
        The response is either a SuccessResponse or an ErrorResponse.

    Attributes:

        collaborate_room_id_length (Optional[int]):

        instant_room_idle_timeout_seconds (Optional[int]):

        collaborate_room_maximum_duration_minutes (Optional[int]):

        support_outdial (Optional[bool]):

        max_collaborate_room_participants (Optional[int]):

        collaborate_active_talker_refresh_interval_seconds (Optional[int]):

        terminate_collaborate_after_grace_period (Optional[bool]):

        collaborate_grace_period (Optional[CollaborateGracePeriodDuration]):

        enable_active_collaborate_notification (Optional[bool]):

        collaborate_from_address (Optional[Nillable[str]]):

    """

    collaborate_room_id_length: Optional[int] = field(
        default=None, metadata={"alias": "collaborateRoomIdLength"}
    )

    instant_room_idle_timeout_seconds: Optional[int] = field(
        default=None, metadata={"alias": "instantRoomIdleTimeoutSeconds"}
    )

    collaborate_room_maximum_duration_minutes: Optional[int] = field(
        default=None, metadata={"alias": "collaborateRoomMaximumDurationMinutes"}
    )

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

    max_collaborate_room_participants: Optional[int] = field(
        default=None, metadata={"alias": "maxCollaborateRoomParticipants"}
    )

    collaborate_active_talker_refresh_interval_seconds: Optional[int] = field(
        default=None,
        metadata={"alias": "collaborateActiveTalkerRefreshIntervalSeconds"},
    )

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

    collaborate_grace_period: Optional[CollaborateGracePeriodDuration] = field(
        default=None, metadata={"alias": "collaborateGracePeriod"}
    )

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

    collaborate_from_address: Optional[Nillable[str]] = field(
        default=None, metadata={"alias": "collaborateFromAddress"}
    )

    def __post_init__(self):
        nillable_fields = ["collaborate_from_address"]
        for field_name in nillable_fields:
            value = getattr(self, field_name)
            if value == "" or value == "None":
                object.__setattr__(self, field_name, OCINil)

Responses

Bases: OCIResponse

Source code in src/mercury_ocip/commands/base_command.py
class SuccessResponse(OCIResponse):
    pass

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 SystemCollaborateModifyRequest20sp1V2

client = Client()

command = SystemCollaborateModifyRequest20sp1V2(
    collaborate_room_id_length=...,
    instant_room_idle_timeout_seconds=...,
    collaborate_room_maximum_duration_minutes=...,
    support_outdial=...,
    max_collaborate_room_participants=...,
    collaborate_active_talker_refresh_interval_seconds=...,
    terminate_collaborate_after_grace_period=...,
    collaborate_grace_period=...,
    enable_active_collaborate_notification=...,
    collaborate_from_address=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("SystemCollaborateModifyRequest20sp1V2",
    collaborate_room_id_length=...,
    instant_room_idle_timeout_seconds=...,
    collaborate_room_maximum_duration_minutes=...,
    support_outdial=...,
    max_collaborate_room_participants=...,
    collaborate_active_talker_refresh_interval_seconds=...,
    terminate_collaborate_after_grace_period=...,
    collaborate_grace_period=...,
    enable_active_collaborate_notification=...,
    collaborate_from_address=...,
)

print(response)