Package pl.gsmservice.gateway

Class Common

java.lang.Object

pl.gsmservice.gateway.Common

public class Common
extends java.lang.Object

Method Summary

Modifier and Type	Method	Description
AsyncCommon	async()	Switches to the async SDK.
PingRequestBuilder	ping()	Checks API availability and version
PingResponse	ping(java.util.Optional<Options> options)	Checks API availability and version
PingResponse	pingDirect()	Checks API availability and version

Methods inherited from class java.lang.Object

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

Method Detail

async

public AsyncCommon async()

Switches to the async SDK.

Returns:

The async SDK

ping

public PingRequestBuilder ping()

Checks API availability and version

Check the API connection and the current API availability status. Also you will get the current API version number. The method doesn't accept any parameters. Please use builder style:

 PingResponse res = sdk.common().ping()
    .call();
 

As a successful result a PingResponse object will be returned.

Returns:

The call builder

pingDirect

public PingResponse pingDirect()
                        throws java.lang.Exception

Checks API availability and version

Check the API connection and the current API availability status. Also you will get the current API version number. The method doesn't accept any parameters. Please use builder style:

 PingResponse res = sdk.common().ping()
    .call();
 

As a successful result a PingResponse object will be returned.

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

ping

public PingResponse ping(java.util.Optional<Options> options)
                  throws java.lang.Exception

Checks API availability and version

Check the API connection and the current API availability status. Also you will get the current API version number. The method doesn't accept any parameters. Please use builder style:

 PingResponse res = sdk.common().ping()
    .call();
 

As a successful result a PingResponse object will be returned.

Parameters:

options - additional options

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails