Skip to content

UserAnnouncementFileGetPagedSortedListRequest

Bases: OCIRequest

Get the list of announcement files for a user. If the responsePagingControl element is not provided, the paging startIndex will be set to 1 by default, and the responsePageSize will be set to the maximum responsePageSize by default. If no sortOrder is provided, the response is sorted by Name ascending by default. Multiple search criteria are logically ANDed together unless the searchCriteriaModeOr option is included. Then the search criteria are logically ORed together. The response is either a UserAnnouncementFileGetPagedSortedListResponse or an ErrorResponse.

Attributes:

user_id (str):

response_paging_control (Optional[ResponsePagingControl]):

sort_by_announcement_file_name (Optional[SortByAnnouncementFileName]):

sort_by_announcement_file_size (Optional[SortByAnnouncementFileSize]):

search_criteria_announcement_file_name (Optional[List[SearchCriteriaAnnouncementFileName]]):

search_criteria_exact_announcement_file_type (Optional[SearchCriteriaExactAnnouncementFileType]):

search_criteria_exact_media_file_type (Optional[List[SearchCriteriaExactMediaFileType]]):

search_criteria_mode_or (Optional[bool]):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class UserAnnouncementFileGetPagedSortedListRequest(OCIRequest):
    """Get the list of announcement files for a user.
        If the responsePagingControl element is not provided,
        the paging startIndex will be set to 1 by default,
        and the responsePageSize will be set to the maximum responsePageSize by
        default.
        If no sortOrder is provided, the response is sorted by Name ascending by default.
        Multiple search criteria are logically ANDed together unless the searchCriteriaModeOr option is included.
        Then the search criteria are logically ORed together.
        The response is either a
        UserAnnouncementFileGetPagedSortedListResponse or an
        ErrorResponse.

    Attributes:

        user_id (str):

        response_paging_control (Optional[ResponsePagingControl]):

        sort_by_announcement_file_name (Optional[SortByAnnouncementFileName]):

        sort_by_announcement_file_size (Optional[SortByAnnouncementFileSize]):

        search_criteria_announcement_file_name (Optional[List[SearchCriteriaAnnouncementFileName]]):

        search_criteria_exact_announcement_file_type (Optional[SearchCriteriaExactAnnouncementFileType]):

        search_criteria_exact_media_file_type (Optional[List[SearchCriteriaExactMediaFileType]]):

        search_criteria_mode_or (Optional[bool]):

    """

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

    response_paging_control: Optional[ResponsePagingControl] = field(
        default=None, metadata={"alias": "responsePagingControl"}
    )

    sort_by_announcement_file_name: Optional[SortByAnnouncementFileName] = field(
        default=None, metadata={"alias": "sortByAnnouncementFileName"}
    )

    sort_by_announcement_file_size: Optional[SortByAnnouncementFileSize] = field(
        default=None, metadata={"alias": "sortByAnnouncementFileSize"}
    )

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

    search_criteria_exact_announcement_file_type: Optional[
        SearchCriteriaExactAnnouncementFileType
    ] = field(
        default=None, metadata={"alias": "searchCriteriaExactAnnouncementFileType"}
    )

    search_criteria_exact_media_file_type: Optional[
        List[SearchCriteriaExactMediaFileType]
    ] = field(default=None, metadata={"alias": "searchCriteriaExactMediaFileType"})

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

Responses

Bases: OCIDataResponse

Response to UserAnnouncementFileGetPagedSortedListRequest. The response contains a table with columns: "Name", "Media Type", "File Size", and "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 (KB) of the announcement file.

Attributes:

announcement_table (Optional[OCITable]):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class UserAnnouncementFileGetPagedSortedListResponse(OCIDataResponse):
    """Response to UserAnnouncementFileGetPagedSortedListRequest.
        The response contains a table with columns: \"Name\", \"Media Type\", \"File Size\", and \"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 (KB) of the announcement file.

    Attributes:

        announcement_table (Optional[OCITable]):

    """

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

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 UserAnnouncementFileGetPagedSortedListRequest

client = Client()

command = UserAnnouncementFileGetPagedSortedListRequest(
    user_id=...,
    response_paging_control=...,
    sort_by_announcement_file_name=...,
    sort_by_announcement_file_size=...,
    search_criteria_announcement_file_name=...,
    search_criteria_exact_announcement_file_type=...,
    search_criteria_exact_media_file_type=...,
    search_criteria_mode_or=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("UserAnnouncementFileGetPagedSortedListRequest",
    user_id=...,
    response_paging_control=...,
    sort_by_announcement_file_name=...,
    sort_by_announcement_file_size=...,
    search_criteria_announcement_file_name=...,
    search_criteria_exact_announcement_file_type=...,
    search_criteria_exact_media_file_type=...,
    search_criteria_mode_or=...,
)

print(response)