wear.operateRecordShareLink

operateRecordShareLink(params: Object)

Requires:

@ray-js/ray≥1.7.82

Platforms:

iOSAndroid

import { wear } from '@ray-js/ray';

const { operateRecordShareLink } = wear;

// Promise usage
try {
  const res = await operateRecordShareLink({ ...params });
  console.log(res);
} catch (err) {
  console.log(err.errorMsg);
}

Description

Operate recording file share link (open or close), determined by shareStatus parameter.

Parameters

Property	Type	Required	Description	Since
`recordId`	string	Yes	Recording record ID	v1.9.1
`shareType`	string[]	Yes	List of content types to share For example: ["audio", "transforme"]	v1.9.1
`expireTime`	number	Yes	Share expiration time	v1.9.1
`password`	string	No	Share password (optional) Leave empty for no password	v1.9.1
`shareStatus`	number	Yes	Share status 1 - Sharing (share link enabled) 2 - Closed (share link disabled)	v1.9.1
`complete`	() => void	No	Completion callback (executed on both success and failure)	-
`success`	(params: Object) => void	No	Callback on successful API call	-
`fail`	(params: Object) => void	No	Failure callback	-

success callback parameters

Property	Type	Description	Since
`title`	string	Share title	v3.0.0
`message`	string	Share description	v3.2.0
`link`	string	Share link	v1.9.1
`validDate`	string	Link validity period	v3.2.2

fail callback parameters

Property	Type	Description
`errorMsg`	string	Error message
`errorCode`	string \| number	Error code
		Error extension

Return Value

None

Error Code

Error Code	Error Message
`10001`	Internal error
`20201`	Contains sensitive content
`20202`	Generic sharing error
`20203`	Invalid password length
`20204`	Missing transcription content

Examples

Basic usage

import { wear } from '@ray-js/ray'

wear.operateRecordShareLink({
  recordId: '',
  shareType: [],
  expireTime: 0,
  shareStatus: 0,
  success: (result) => {
    console.log('operateRecordShareLink success', result);
  },
  fail: error => {
    console.error(error);
  },
});