org.openapitools.client.api

Class ApplicationLogosApi

java.lang.Object

org.openapitools.client.api.ApplicationLogosApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-07-14T17:07:26.321-05:00[America/Chicago]")
public class ApplicationLogosApi
extends Object

Constructor Summary

Constructors

Constructor and Description
ApplicationLogosApi()
ApplicationLogosApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
protected static com.fasterxml.jackson.databind.ObjectMapper	getObjectMapper()
void	setApiClient(ApiClient apiClient)
void	uploadApplicationLogo(String appId, File _file) Upload an application Logo Uploads a logo for the app instance.
void	uploadApplicationLogo(String appId, File _file, Map<String,String> additionalHeaders) Upload an application Logo Uploads a logo for the app instance.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ApplicationLogosApi

public ApplicationLogosApi()

ApplicationLogosApi

public ApplicationLogosApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

uploadApplicationLogo

public void uploadApplicationLogo(String appId,
                                  File _file)
                           throws ApiException

Upload an application Logo Uploads a logo for the app instance. If the app already has a logo, this operation replaces the previous logo. The logo is visible in the Admin Console as an icon for your app instance. If you have one `appLink` object configured, this logo also appears in the End-User Dashboard as an icon for your app. > **Note:** If you have multiple `appLink` objects, use the Admin Console to add logos for each app link. > You can't use the API to add logos for multiple app links.

Parameters:

appId - ID of the Application (required)

_file - The image file containing the logo. The file must be in PNG, JPG, SVG, or GIF format, and less than one MB in size. For best results, use an image with a transparent background and a square dimension of 200 x 200 pixels to prevent upscaling. (required)

Throws:

ApiException - if fails to make API call

uploadApplicationLogo

public void uploadApplicationLogo(String appId,
                                  File _file,
                                  Map<String,String> additionalHeaders)
                           throws ApiException

Upload an application Logo Uploads a logo for the app instance. If the app already has a logo, this operation replaces the previous logo. The logo is visible in the Admin Console as an icon for your app instance. If you have one `appLink` object configured, this logo also appears in the End-User Dashboard as an icon for your app. > **Note:** If you have multiple `appLink` objects, use the Admin Console to add logos for each app link. > You can't use the API to add logos for multiple app links.

Parameters:

appId - ID of the Application (required)

_file - The image file containing the logo. The file must be in PNG, JPG, SVG, or GIF format, and less than one MB in size. For best results, use an image with a transparent background and a square dimension of 200 x 200 pixels to prevent upscaling. (required)

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call

getObjectMapper

protected static com.fasterxml.jackson.databind.ObjectMapper getObjectMapper()