Function: getActivitiesByIdPoster()

getActivitiesByIdPoster<ThrowOnError>(options): RequestResult<GetActivitiesByIdPosterResponses, GetActivitiesByIdPosterErrors, ThrowOnError>

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

Retrieves the poster image for a specific activity by its unique identifier. The GetPoster endpoint allows clients to fetch the poster image associated with an existing activity based on the provided ID. This endpoint is designed to return the poster image 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 the correct content type, allowing clients to easily display or manage activity posters as needed. Additionally, this endpoint supports an optional download parameter that allows clients to specify whether they want to download the poster file directly or display it in the browser, providing flexibility in how clients can access and utilize activity posters within their applications.

Type Parameters

ThrowOnError

ThrowOnError *extends* boolean = false

Parameters

options

Options<GetActivitiesByIdPosterData, ThrowOnError>

Returns

RequestResult<GetActivitiesByIdPosterResponses, GetActivitiesByIdPosterErrors, ThrowOnError>