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
100398 100399 100400 100401 100402 100403 100404 100405 100406 100407 100408 100409 100410 100411 100412 100413 100414 100415 100416 100417 100418 100419 100420 100421 100422 100423 100424 100425 100426 100427 100428 100429 100430 100431 100432 100433 100434 100435 100436 100437 100438 100439 100440 100441 100442 100443 100444 100445 100446 100447 100448 100449 100450 100451 100452 100453 100454 100455 100456 100457 100458 100459 100460 100461 100462 | |
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
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)