GroupAnnouncementFileGetListRequest
Bases: OCIRequest
Get the list of available announcement files for a Group.
The following elements are only used in AS data mode and ignored in XS data mode:
groupExternalId
The response is either a GroupAnnouncementFileGetListResponse or an ErrorResponse.
Attributes:
service_provider_id (Optional[str]):
group_id (Optional[str]):
group_external_id (Optional[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
33092 33093 33094 33095 33096 33097 33098 33099 33100 33101 33102 33103 33104 33105 33106 33107 33108 33109 33110 33111 33112 33113 33114 33115 33116 33117 33118 33119 33120 33121 33122 33123 33124 33125 33126 33127 33128 33129 33130 33131 33132 33133 33134 33135 33136 33137 33138 33139 33140 33141 33142 33143 | |
Responses
Bases: OCIDataResponse
Response to GroupAnnouncementFileGetListRequest. 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 (KB) of the announcement file. The "Announcement File External Id" column contains the External ID of the announcement file. The response also contains the current total file size (KB) for the group across all media types and the maximum total file size (MB) allowed for the group.
The following columns are populated in AS data mode only:
"Announcement File External Id"
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 GroupAnnouncementFileGetListRequest
client = Client()
command = GroupAnnouncementFileGetListRequest(
service_provider_id=...,
group_id=...,
group_external_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.client import Client
client = Client()
response = client.raw_command("GroupAnnouncementFileGetListRequest",
service_provider_id=...,
group_id=...,
group_external_id=...,
announcement_file_type=...,
include_announcement_table=...,
response_size_limit=...,
search_criteria_announcement_file_name=...,
)
print(response)