Function: getActivitiesByIdPosterDownload()

getActivitiesByIdPosterDownload<ThrowOnError>(options): RequestResult<GetActivitiesByIdPosterDownloadResponses, GetActivitiesByIdPosterDownloadErrors, ThrowOnError>

Defined in: app/api/sdk.gen.ts:119

Downloads the poster image for a specific activity by its unique identifier. The DownloadPoster endpoint allows clients to fetch the poster image associated with an existing activity based on the provided ID, specifically for the purpose of downloading the file directly. This endpoint is designed to return the poster image file with the appropriate content type and a content disposition that prompts the client to download the file, ensuring that proper authorization is enforced to allow only authorized users to access activity posters, while also providing appropriate error handling for cases where the activity or poster may not be found. Upon successful retrieval, the endpoint returns the poster image file with a filename, allowing clients to easily download and manage activity posters as needed. This endpoint provides a convenient way for clients to access and utilize activity posters within their applications by enabling direct downloads of poster files.

Type Parameters

ThrowOnError

ThrowOnError *extends* boolean = false

Parameters

options

Options<GetActivitiesByIdPosterDownloadData, ThrowOnError>

Returns

RequestResult<GetActivitiesByIdPosterDownloadResponses, GetActivitiesByIdPosterDownloadErrors, ThrowOnError>