com.netease.nimlib.sdk.nos

Interface NosService

public interface NosService

CommsEase storage service

Method Summary

Modifier and Type	Method and Description
java.lang.String	convertDownloadUrlToCDNUrl(java.lang.String url) Convert a file URL to an acceleration URL over CDN.
AbortableFuture<java.lang.Void>	download(java.lang.String url, NosThumbParam thumb, java.lang.String path) Download files
AbortableFuture<java.lang.Void>	downloadFileSecure(java.lang.String url, java.lang.String path) Download a file through a secure link
InvocationFuture<java.lang.String>	getOriginUrlFromShortUrl(java.lang.String shortUrl) Get the origin URL from a short URL for clients that have activated the security service for files stored on NOS.
InvocationFuture<java.lang.String>	getOriginUrlFromShortUrl(java.lang.String roomId, java.lang.String shortUrl) Get the origin URL from a short URL for clients that have activated the security service for files stored on NOS.
AbortableFuture<java.lang.String>	upload(java.io.File file, java.lang.String mimeType) Upload files using the default NOS scene NimNosSceneKeyConstant#NIM_DEFAULT_PROFILE For more information, see uploadAtScene(File, String, String)
AbortableFuture<java.lang.String>	uploadAtScene(java.io.File file, java.lang.String mimeType, java.lang.String sceneKey) The same as upload(File, String) with specified NOS scene.
AbortableFuture<java.lang.String>	uploadEnableForce(java.io.File file, java.lang.String mimeType, java.lang.String sceneKey, boolean enableForceUploadFile) The same as upload(File, String) with specified NOS scene and the option whether to forcibly resume uploads.

Method Detail

upload

AbortableFuture<java.lang.String> upload(java.io.File file,
                                         java.lang.String mimeType)

Upload files using the default NOS scene NimNosSceneKeyConstant#NIM_DEFAULT_PROFILE For more information, see uploadAtScene(File, String, String)

Parameters:

file - file

mimeType - file type

Returns:

AbortableFuture

uploadAtScene

AbortableFuture<java.lang.String> uploadAtScene(java.io.File file,
                                                java.lang.String mimeType,
                                                java.lang.String sceneKey)

The same as upload(File, String) with specified NOS scene.

Parameters:

file - file

mimeType - file type

sceneKey - The NOS sceneKey for uploads. Default value: NimNosSceneKeyConstant#NIM_DEFAULT_PROFILE. For information about how to configure NOS token scene, seeNosTokenSceneConfig.

Returns:

AbortableFuture

uploadEnableForce

AbortableFuture<java.lang.String> uploadEnableForce(java.io.File file,
                                                    java.lang.String mimeType,
                                                    java.lang.String sceneKey,
                                                    boolean enableForceUploadFile)

The same as upload(File, String) with specified NOS scene and the option whether to forcibly resume uploads.

Parameters:

file - file

mimeType - file type

sceneKey - The NOS sceneKey for uploads. Default value: NimNosSceneKeyConstant#NIM_DEFAULT_PROFILE. For information about how to configure NOS token scene, seeNosTokenSceneConfig.

enableForceUploadFile - The option to specify whether to forcibly resume uploads. The default value is false.

Returns:

AbortableFuture

download

AbortableFuture<java.lang.Void> download(java.lang.String url,
                                         NosThumbParam thumb,
                                         java.lang.String path)

Download files

Parameters:

url - File URL

thumb - Thumbnail configuration

path - Download location

Returns:

AbortableFuture

downloadFileSecure

AbortableFuture<java.lang.Void> downloadFileSecure(java.lang.String url,
                                                   java.lang.String path)

Download a file through a secure link

Parameters:

url - File URL

path - Download location

Returns:

AbortableFuture

convertDownloadUrlToCDNUrl

java.lang.String convertDownloadUrlToCDNUrl(java.lang.String url)

Convert a file URL to an acceleration URL over CDN. If the acceleration URL is not supported, return the origin URL.

Parameters:

url - The origin URL

Returns:

CDN accelerated URL. If the acceleration URL is not supported, return the origin URL.

getOriginUrlFromShortUrl

InvocationFuture<java.lang.String> getOriginUrlFromShortUrl(java.lang.String shortUrl)

Get the origin URL from a short URL for clients that have activated the security service for files stored on NOS. This way the origin URL can be protected.

Parameters:

shortUrl - The short URL. If the parameter is not a long URL, 414 is returned.

Returns:

InvocationFuture

getOriginUrlFromShortUrl

InvocationFuture<java.lang.String> getOriginUrlFromShortUrl(java.lang.String roomId,
                                                            java.lang.String shortUrl)

Get the origin URL from a short URL for clients that have activated the security service for files stored on NOS. This way the origin URL can be protected.

Parameters:

roomId - The ID of a chat room

shortUrl - The short URL. If the parameter is not a long URL, 414 is returned.

Returns:

InvocationFuture