RecipientTransfers interface
表示 RecipientTransfers 的接口。
方法
| accept(string, Accept |
接受转移请求。 |
| decline(string, Recipient |
拒绝转移请求。 |
| get(string, Recipient |
按 ID 获取传输请求。 呼叫方必须是转移请求的接收方。 |
| list(Recipient |
列出调用方收到的传输请求。 |
| validate(string, Accept |
验证是否可以转移订阅或预留。 使用此作在使用接受转移作之前验证订阅或预留。 |
方法详细信息
accept(string, AcceptTransferRequest, RecipientTransfersAcceptOptionalParams)
接受转移请求。
function accept(transferName: string, parameters: AcceptTransferRequest, options?: RecipientTransfersAcceptOptionalParams): Promise<RecipientTransferDetails>
参数
- transferName
-
string
唯一标识传输请求的 ID。
- parameters
- AcceptTransferRequest
向接受传输作提供的请求参数。
选项参数。
返回
Promise<RecipientTransferDetails>
decline(string, RecipientTransfersDeclineOptionalParams)
拒绝转移请求。
function decline(transferName: string, options?: RecipientTransfersDeclineOptionalParams): Promise<RecipientTransferDetails>
参数
- transferName
-
string
唯一标识传输请求的 ID。
选项参数。
返回
Promise<RecipientTransferDetails>
get(string, RecipientTransfersGetOptionalParams)
按 ID 获取传输请求。 呼叫方必须是转移请求的接收方。
function get(transferName: string, options?: RecipientTransfersGetOptionalParams): Promise<RecipientTransferDetails>
参数
- transferName
-
string
唯一标识传输请求的 ID。
选项参数。
返回
Promise<RecipientTransferDetails>
list(RecipientTransfersListOptionalParams)
列出调用方收到的传输请求。
function list(options?: RecipientTransfersListOptionalParams): PagedAsyncIterableIterator<RecipientTransferDetails, RecipientTransferDetails[], PageSettings>
参数
选项参数。
返回
validate(string, AcceptTransferRequest, RecipientTransfersValidateOptionalParams)
验证是否可以转移订阅或预留。 使用此作在使用接受转移作之前验证订阅或预留。
function validate(transferName: string, parameters: AcceptTransferRequest, options?: RecipientTransfersValidateOptionalParams): Promise<ValidateTransferListResponse>
参数
- transferName
-
string
唯一标识传输请求的 ID。
- parameters
- AcceptTransferRequest
向验证传输作提供的请求参数。
选项参数。
返回
Promise<ValidateTransferListResponse>