Skip to content

UserAnnouncementFileGetListRequest

Bases: OCIRequest

Get the list of announcement names with associated media type and filesize for a User and given Announcement Repository Type The response is either a UserAnnouncementFileGetListResponse or an ErrorResponse.

Attributes:

user_id (str):

announcement_file_type (Optional[str]):

include_announcement_table (bool):

response_size_limit (Optional[int]):

search_criteria_announcement_file_name (Optional[List[SearchCriteriaAnnouncementFileName]]):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class UserAnnouncementFileGetListRequest(OCIRequest):
    """Get the list of announcement names with associated media type and filesize for a User and
        given Announcement Repository Type
        The response is either a UserAnnouncementFileGetListResponse or an ErrorResponse.

    Attributes:

        user_id (str):

        announcement_file_type (Optional[str]):

        include_announcement_table (bool):

        response_size_limit (Optional[int]):

        search_criteria_announcement_file_name (Optional[List[SearchCriteriaAnnouncementFileName]]):

    """

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

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

    include_announcement_table: bool = field(
        metadata={"alias": "includeAnnouncementTable"}
    )

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

    search_criteria_announcement_file_name: Optional[
        List[SearchCriteriaAnnouncementFileName]
    ] = field(default=None, metadata={"alias": "searchCriteriaAnnouncementFileName"})

Responses

Bases: OCIDataResponse

Response to UserAnnouncementFileGetListRequest. When requested, the response contains a table with columns: "Name", "Media Type", "File Size", "Announcement File External Id". The "Name" column contains the name of the announcement file. The "Media Type" column contains the media type of the announcement file with the possible values: WMA - Windows Media Audio file WAV - A WAV file 3GP - A 3GP file MOV - A MOV file using a H.263 or H.264 codec. The "File Size" column contains the file size in kB of the announcement file. The "Announcement File External Id" column contains the external ID of the announcement file.

The following columns are populated in AS data mode only:
  "Announcement File External Id"

The response also contains the current total file size (KB) for the user across
all media types and the maximum total file size (MB) allowed for the user.

Attributes:

announcement_table (Optional[OCITable]):

total_file_size (int):

max_file_size (int):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class UserAnnouncementFileGetListResponse(OCIDataResponse):
    """Response to UserAnnouncementFileGetListRequest.
        When requested, the response contains a table with columns: \"Name\",
        \"Media Type\", \"File Size\", \"Announcement File External Id\".
        The \"Name\" column contains the name of the announcement file.
        The \"Media Type\" column contains the media type of the announcement file with the possible values:
                WMA - Windows Media Audio file
                WAV - A WAV file
                3GP - A 3GP file
                MOV - A MOV file using a H.263 or H.264 codec.
        The \"File Size\" column contains the file size in kB of the announcement file.
        The \"Announcement File External Id\" column contains the external ID of the announcement file.

        The following columns are populated in AS data mode only:
          \"Announcement File External Id\"

        The response also contains the current total file size (KB) for the user across
        all media types and the maximum total file size (MB) allowed for the user.

    Attributes:

        announcement_table (Optional[OCITable]):

        total_file_size (int):

        max_file_size (int):

    """

    announcement_table: Optional[OCITable] = field(
        default=None, metadata={"alias": "announcementTable"}
    )

    total_file_size: int = field(metadata={"alias": "totalFileSize"})

    max_file_size: int = field(metadata={"alias": "maxFileSize"})

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 UserAnnouncementFileGetListRequest

client = Client()

command = UserAnnouncementFileGetListRequest(
    user_id=...,
    announcement_file_type=...,
    include_announcement_table=...,
    response_size_limit=...,
    search_criteria_announcement_file_name=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("UserAnnouncementFileGetListRequest",
    user_id=...,
    announcement_file_type=...,
    include_announcement_table=...,
    response_size_limit=...,
    search_criteria_announcement_file_name=...,
)

print(response)