Package pl.gsmservice.gateway

Class Common

java.lang.Object

pl.gsmservice.gateway.Common

All Implemented Interfaces:

SDKMethodInterfaces.MethodCallPing

public class Common
extends java.lang.Object
implements SDKMethodInterfaces.MethodCallPing

Method Summary

Modifier and Type	Method	Description
PingRequestBuilder	ping()	Checks API availability and version Check the API connection and the current API availability status.
PingResponse	ping(java.util.Optional<Options> options)	Checks API availability and version Check the API connection and the current API availability status.
PingResponse	pingDirect()	Checks API availability and version Check the API connection and the current API availability status.

Methods inherited from class java.lang.Object

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

Method Detail

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.

Specified by:

ping in interface SDKMethodInterfaces.MethodCallPing

Parameters:

options - additional options

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails