Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • NIMEModuleParamCloudStorageConfig

Index

Properties

cdn?: { bucket?: string; cdnDomain?: string; defaultCdnDomain?: string; objectNamePrefix?: string }

NOS 上传专用的 cdn 配置

Type declaration

  • Optional bucket?: string

    桶名, 一般 NOS 默认为 "nim"

  • Optional cdnDomain?: string

    下载域名

  • Optional defaultCdnDomain?: string

    默认的下载域名

  • Optional objectNamePrefix?: string

    路径前缀,一般不需要填写

chunkUploadHost?: string

NOS上传地址(分片)

commonUploadHost?: string

NOS上传地址(直传)

downloadHostList?: string[]

收到哪些host地址,需要替换成downloadUrl,例:收到nos.netease.com/{bucket}/{obj}

downloadUrl?: string

接收到文件消息的替换模版 这个是用来接到消息后,要按一定模式替换掉文件链接的。给予一个安全下载链接。 例:'https://{bucket}-nosdn.netease.im/{object}'

isNeedToGetUploadPolicyFromServer?: boolean

是否需要开启融合存储整个策略。默认为 true

注: 为 false 则不会进行 lbs 灰度开关和策略获取,直接退化到老的 nos 上传逻辑。

nosCdnEnable?: boolean

服务器下发的域名存在,并且对象前缀匹配成功,那么强行替换为${protocol}${serverCdnDomain}/${decodePath.slice(prefixIndex)}

s3?: any

amazon aws s3 sdk

// 1. 安装 s3 sdk: npm install @aws-sdk/client-SERVICE
// 2. 引入 s3 sdk: import {S3} from "@aws-sdk/client-s3"
// 3. 初始化时设置 s3 SDK:
NIM.getInstance(
{
appkey: 'YOUR_APPKEY',
token: 'YOUR_TOKEN',
account: 'YOUR_ACCOUNT'
},
{
cloudStorageConfig: {
s3: S3
}
})

注:若传入 s3 sdk 后,本 SDK 根据融合存储策略配置,可能会 new 创建出它的实例并使用它的实例方法进行上传/存储。

storageKeyPrefix?: string

localStorage 缓存的云存储配置的键名的前缀。默认叫 NIMClient

注: 举个例子,根据默认配置,策略缓存的键叫 'NIMClient-AllGrayscaleConfig'。

uploadReplaceFormat?: string

发送文件消息中文件的url的通配符地址,例:'https://{host}/{object}'