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/commands/commands.py
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/commands/commands.py
Example Usage
from mercury_ocip.client import Client
from mercury_ocip.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)