ch.postfinance.sdk.service

Class WebAppService

java.lang.Object

ch.postfinance.sdk.service.WebAppService

public class WebAppService
extends Object

Constructor Summary

Constructors

Constructor and Description
WebAppService(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
Boolean	checkInstallation(Long spaceId) Check Installation This operation returns true when the app is installed in given space.
Boolean	checkInstallation(Long spaceId, Map<String,Object> params) Check Installation This operation returns true when the app is installed in given space.
com.google.api.client.http.HttpResponse	checkInstallationForHttpResponse(Long spaceId)
com.google.api.client.http.HttpResponse	checkInstallationForHttpResponse(Long spaceId, Map<String,Object> params)
WebAppConfirmationResponse	confirm(WebAppConfirmationRequest request) Confirm This operation confirms the app installation.
WebAppConfirmationResponse	confirm(WebAppConfirmationRequest request, Map<String,Object> params) Confirm This operation confirms the app installation.
com.google.api.client.http.HttpResponse	confirmForHttpResponse(InputStream request, String mediaType)
com.google.api.client.http.HttpResponse	confirmForHttpResponse(WebAppConfirmationRequest request)
com.google.api.client.http.HttpResponse	confirmForHttpResponse(WebAppConfirmationRequest request, Map<String,Object> params)
ApiClient	getApiClient()
void	setApiClient(ApiClient apiClient)
void	uninstall(Long spaceId) Uninstall This operation uninstalls the web app from the provided space.
void	uninstall(Long spaceId, Map<String,Object> params) Uninstall This operation uninstalls the web app from the provided space.
com.google.api.client.http.HttpResponse	uninstallForHttpResponse(Long spaceId)
com.google.api.client.http.HttpResponse	uninstallForHttpResponse(Long spaceId, Map<String,Object> params)

Methods inherited from class java.lang.Object

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

Constructor Detail

WebAppService

public WebAppService(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

checkInstallation

public Boolean checkInstallation(Long spaceId)
                          throws IOException

Check Installation This operation returns true when the app is installed in given space. The web app is implied by the client ID resp. user ID that is been used to invoke this operation.

200 - This status code indicates that a client request was successfully received, understood, and accepted.

442 - This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.

542 - This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

Parameters:

spaceId - This parameter identifies the space which should be checked if the web app is installed.

Returns:

Boolean

Throws:

IOException - if an error occurs while attempting to invoke the API For more information visit this link.

See Also:

Check Installation Documentation

checkInstallation

public Boolean checkInstallation(Long spaceId,
                                 Map<String,Object> params)
                          throws IOException

Check Installation This operation returns true when the app is installed in given space. The web app is implied by the client ID resp. user ID that is been used to invoke this operation.

200 - This status code indicates that a client request was successfully received, understood, and accepted.

442 - This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.

542 - This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

Parameters:

spaceId - This parameter identifies the space which should be checked if the web app is installed.

params - Map of query params. A collection will be interpreted as passing in multiple instances of the same query param.

Returns:

Boolean

Throws:

IOException - if an error occurs while attempting to invoke the API For more information visit this link.

See Also:

Check Installation Documentation

checkInstallationForHttpResponse

public com.google.api.client.http.HttpResponse checkInstallationForHttpResponse(Long spaceId)
                                                                         throws IOException

Throws:

IOException

checkInstallationForHttpResponse

public com.google.api.client.http.HttpResponse checkInstallationForHttpResponse(Long spaceId,
                                                                                Map<String,Object> params)
                                                                         throws IOException

Throws:

IOException

confirm

public WebAppConfirmationResponse confirm(WebAppConfirmationRequest request)
                                   throws IOException

Confirm This operation confirms the app installation. This method has to be invoked after the user returns to the web app. The request of the user will contain the code as a request parameter. The web app is implied by the client ID resp. user ID that is been used to invoke this operation.

200 - This status code indicates that a client request was successfully received, understood, and accepted.

442 - This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.

542 - This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

Parameters:

request -

Returns:

WebAppConfirmationResponse

Throws:

IOException - if an error occurs while attempting to invoke the API For more information visit this link.

See Also:

Confirm Documentation

confirm

public WebAppConfirmationResponse confirm(WebAppConfirmationRequest request,
                                          Map<String,Object> params)
                                   throws IOException

Confirm This operation confirms the app installation. This method has to be invoked after the user returns to the web app. The request of the user will contain the code as a request parameter. The web app is implied by the client ID resp. user ID that is been used to invoke this operation.

200 - This status code indicates that a client request was successfully received, understood, and accepted.

442 - This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.

542 - This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

Parameters:

request -

params - Map of query params. A collection will be interpreted as passing in multiple instances of the same query param.

Returns:

WebAppConfirmationResponse

Throws:

IOException - if an error occurs while attempting to invoke the API For more information visit this link.

See Also:

Confirm Documentation

confirmForHttpResponse

public com.google.api.client.http.HttpResponse confirmForHttpResponse(WebAppConfirmationRequest request)
                                                               throws IOException

Throws:

IOException

confirmForHttpResponse

public com.google.api.client.http.HttpResponse confirmForHttpResponse(InputStream request,
                                                                      String mediaType)
                                                               throws IOException

Throws:

IOException

confirmForHttpResponse

public com.google.api.client.http.HttpResponse confirmForHttpResponse(WebAppConfirmationRequest request,
                                                                      Map<String,Object> params)
                                                               throws IOException

Throws:

IOException

uninstall

public void uninstall(Long spaceId)
               throws IOException

Uninstall This operation uninstalls the web app from the provided space. The web app is implied by the client ID resp. user ID that is been used to invoke this operation.

442 - This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.

542 - This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

Parameters:

spaceId - This parameter identifies the space within which the web app should be uninstalled.

Throws:

IOException - if an error occurs while attempting to invoke the API For more information visit this link.

See Also:

Uninstall Documentation

uninstall

public void uninstall(Long spaceId,
                      Map<String,Object> params)
               throws IOException

Uninstall This operation uninstalls the web app from the provided space. The web app is implied by the client ID resp. user ID that is been used to invoke this operation.

442 - This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.

542 - This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

Parameters:

spaceId - This parameter identifies the space within which the web app should be uninstalled.

params - Map of query params. A collection will be interpreted as passing in multiple instances of the same query param.

Throws:

IOException - if an error occurs while attempting to invoke the API For more information visit this link.

See Also:

Uninstall Documentation

uninstallForHttpResponse

public com.google.api.client.http.HttpResponse uninstallForHttpResponse(Long spaceId)
                                                                 throws IOException

Throws:

IOException

uninstallForHttpResponse

public com.google.api.client.http.HttpResponse uninstallForHttpResponse(Long spaceId,
                                                                        Map<String,Object> params)
                                                                 throws IOException

Throws:

IOException