Agora Interactive Whiteboard Java API Reference
Public Member Functions | List of all members
com.herewhite.sdk.domain.ConnectionPrepareParam Class Reference

Public Member Functions

 ConnectionPrepareParam (String appId, Region region)
 
 ConnectionPrepareParam (String appId, Region region, Long expire)
 
String getAppId ()
 
Region getRegion ()
 
Long getExpire ()
 

Detailed Description

The whiteboard connection preparation parameters.

Constructor & Destructor Documentation

◆ ConnectionPrepareParam() [1/2]

com.herewhite.sdk.domain.ConnectionPrepareParam.ConnectionPrepareParam ( String  appId,
Region  region 
)

Creates a ConnectionPrepareParam instance.

Parameters
appIdThe unique identifier for a whiteboard project, which can be obtained from the console. See Get security credentials for your whiteboard project.
regionThe region where the user's app is located, see Region.

By default, there is no further connection check within 12 hours.

◆ ConnectionPrepareParam() [2/2]

com.herewhite.sdk.domain.ConnectionPrepareParam.ConnectionPrepareParam ( String  appId,
Region  region,
Long  expire 
)

Creates a ConnectionPrepareParam instance.

Parameters
appIdThe unique identifier for a whiteboard project, which can be obtained from the console. See Get security credentials for your whiteboard project.
regionThe region where the user's app is located, see Region.
expireExpiration time, no further connection check within the time. Default is 12 hours.

Member Function Documentation

◆ getAppId()

String com.herewhite.sdk.domain.ConnectionPrepareParam.getAppId ( )

Gets the unique identifier for a whiteboard project.

◆ getRegion()

Region com.herewhite.sdk.domain.ConnectionPrepareParam.getRegion ( )

Gets the region where the user's app is located.

◆ getExpire()

Long com.herewhite.sdk.domain.ConnectionPrepareParam.getExpire ( )

Gets the expiration time.