Skip to content

UserMeetMeConferencingModifyConferenceRequest

Bases: OCIRequest

Modify an existing conference. The response is either SuccessResponse or ErrorResponse. The startTime element is adjusted to the first occurrence of the recurrent schedule that comes at or after the startTime. The startTime, endTime and recurrence information for a conferenceSchedule element will be adjusted to the user Host time zone.

Attributes:

user_id (str):

conference_key (MeetMeConferencingConferenceKey):

title (Optional[str]):

estimated_participants (Optional[Nillable[int]]):

restrict_participants (Optional[bool]):

max_participants (Optional[int]):

account_code (Optional[Nillable[str]]):

mute_all_attendees_on_entry (Optional[bool]):

end_conference_on_moderator_exit (Optional[bool]):

moderator_required (Optional[bool]):

require_security_pin (Optional[bool]):

allow_unique_identifier (Optional[bool]):

attendee_notification (Optional[str]):

conference_schedule (Optional[MeetMeConferencingConferenceSchedule]):

allow_participant_unmute_in_auto_lecture_mode (Optional[bool]):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class UserMeetMeConferencingModifyConferenceRequest(OCIRequest):
    """Modify an existing conference.
        The response is either SuccessResponse or ErrorResponse.
        The startTime element is adjusted to the first occurrence of the recurrent schedule that comes at or after the startTime.
        The startTime, endTime and recurrence information for a conferenceSchedule element will be adjusted to the user Host time zone.

    Attributes:

        user_id (str):

        conference_key (MeetMeConferencingConferenceKey):

        title (Optional[str]):

        estimated_participants (Optional[Nillable[int]]):

        restrict_participants (Optional[bool]):

        max_participants (Optional[int]):

        account_code (Optional[Nillable[str]]):

        mute_all_attendees_on_entry (Optional[bool]):

        end_conference_on_moderator_exit (Optional[bool]):

        moderator_required (Optional[bool]):

        require_security_pin (Optional[bool]):

        allow_unique_identifier (Optional[bool]):

        attendee_notification (Optional[str]):

        conference_schedule (Optional[MeetMeConferencingConferenceSchedule]):

        allow_participant_unmute_in_auto_lecture_mode (Optional[bool]):

    """

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

    conference_key: MeetMeConferencingConferenceKey = field(
        metadata={"alias": "conferenceKey"}
    )

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

    estimated_participants: Optional[Nillable[int]] = field(
        default=None, metadata={"alias": "estimatedParticipants"}
    )

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

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

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

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

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

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

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

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

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

    conference_schedule: Optional[MeetMeConferencingConferenceSchedule] = field(
        default=None, metadata={"alias": "conferenceSchedule"}
    )

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

    def __post_init__(self):
        nillable_fields = ["estimated_participants", "account_code"]
        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_fast/commands/base_command.py
class SuccessResponse(OCIResponse):
    pass

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 UserMeetMeConferencingModifyConferenceRequest

client = Client()

command = UserMeetMeConferencingModifyConferenceRequest(
    user_id=...,
    conference_key=...,
    title=...,
    estimated_participants=...,
    restrict_participants=...,
    max_participants=...,
    account_code=...,
    mute_all_attendees_on_entry=...,
    end_conference_on_moderator_exit=...,
    moderator_required=...,
    require_security_pin=...,
    allow_unique_identifier=...,
    attendee_notification=...,
    conference_schedule=...,
    allow_participant_unmute_in_auto_lecture_mode=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("UserMeetMeConferencingModifyConferenceRequest",
    user_id=...,
    conference_key=...,
    title=...,
    estimated_participants=...,
    restrict_participants=...,
    max_participants=...,
    account_code=...,
    mute_all_attendees_on_entry=...,
    end_conference_on_moderator_exit=...,
    moderator_required=...,
    require_security_pin=...,
    allow_unique_identifier=...,
    attendee_notification=...,
    conference_schedule=...,
    allow_participant_unmute_in_auto_lecture_mode=...,
)

print(response)