com.netease.nimlib.sdk

Class NosTokenSceneConfig

java.lang.Object

com.netease.nimlib.sdk.NosTokenSceneConfig

public class NosTokenSceneConfig
extends java.lang.Object

SDK configuration for NOS token. If not configured, the default value is applied. The default value is applicable for only the following scenarios:

See Also:

NimNosSceneKeyConstant#NIM_DEFAULT_PROFILE, NimNosSceneKeyConstant#NIM_DEFAULT_IM,

The default expiration time for the default scenario is {@link #NEVER_EXPIRE}. You can modify the expiration time for the default scenario. You can add new scenarios and specify the expiration time (sceneKey-> expireTimeByDay). A maximum of 10 scenarios can be added.

When app users send a message or upload a file, the scenario can be specified. If unspecified, the default value applies. To specify a scenario, use the corresponding sceneKey.

We recommend that you make the corresponding sceneKey a constant during configuration for easy use. For more information, see {@link NimNosSceneKeyConstant}.

Field Summary

Fields

Modifier and Type	Field and Description
static long	NEVER_EXPIRE Never expires, resources are always stored in the server.

Constructor Summary

Constructors

Constructor and Description
NosTokenSceneConfig()

Method Summary

Modifier and Type	Method and Description
NosTokenSceneConfig	appendCustomScene(java.lang.String sceneKey, int expireTime) Add custom scenarios.
static NosTokenSceneConfig	defaultConfig()
java.util.HashMap<java.lang.String,java.lang.Long>	getNosTokenScene() Get all scenario copies.
void	updateDefaultIMSceneExpireTime(int expireTime) Update the expiration time for the default scenario NimNosSceneKeyConstant#NIM_DEFAULT_IM
void	updateDefaultProfileSceneExpireTime(int expireTime) Update the expiration time for the default scenario NimNosSceneKeyConstant#NIM_DEFAULT_PROFILE

Methods inherited from class java.lang.Object

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

Field Detail

NEVER_EXPIRE

public static final long NEVER_EXPIRE

Never expires, resources are always stored in the server.

See Also:

Constant Field Values

Constructor Detail

NosTokenSceneConfig

public NosTokenSceneConfig()

Method Detail

updateDefaultProfileSceneExpireTime

public void updateDefaultProfileSceneExpireTime(int expireTime)

Update the expiration time for the default scenario NimNosSceneKeyConstant#NIM_DEFAULT_PROFILE

Parameters:

expireTime - Expiration time. A value of 0 indicates that the scenario never expires. Unit: days.

updateDefaultIMSceneExpireTime

public void updateDefaultIMSceneExpireTime(int expireTime)

Update the expiration time for the default scenario NimNosSceneKeyConstant#NIM_DEFAULT_IM

Parameters:

expireTime - Expiration time. A value of 0 indicates that the scenario never expires. Unit: days.

appendCustomScene

public NosTokenSceneConfig appendCustomScene(java.lang.String sceneKey,
                                             int expireTime)

Add custom scenarios.

Parameters:

sceneKey - The key for the custom scenario. The sceneKey is required for the custom scene.

expireTime - Expiration time. A value of 0 indicates that the scenario never expires. Unit: days.

Returns:

NosTokenSceneConfig

getNosTokenScene

public java.util.HashMap<java.lang.String,java.lang.Long> getNosTokenScene()

Get all scenario copies.

Returns:

HashMap that contains all scenarios.

defaultConfig

public static NosTokenSceneConfig defaultConfig()