RecipientTransfers interface
Интерфейс, представляющий RecipientTransfers.
Методы
| accept(string, Accept |
Принимает запрос на передачу. |
| decline(string, Recipient |
Отклоняет запрос на передачу. |
| get(string, Recipient |
Возвращает запрос на передачу по идентификатору. Вызывающий объект должен быть получателем запроса на передачу. |
| list(Recipient |
Перечисляет запросы на передачу, полученные вызывающим абонентом. |
| validate(string, Accept |
Проверяет, можно ли передать подписку или резервирование. Используйте эту операцию для проверки подписок или резервирования перед использованием операции приема передачи. |
Сведения о методе
accept(string, AcceptTransferRequest, RecipientTransfersAcceptOptionalParams)
Принимает запрос на передачу.
function accept(transferName: string, parameters: AcceptTransferRequest, options?: RecipientTransfersAcceptOptionalParams): Promise<RecipientTransferDetails>
Параметры
- transferName
-
string
Идентификатор, который однозначно идентифицирует запрос на передачу.
- parameters
- AcceptTransferRequest
Параметры запроса, предоставляемые для операции приема передачи.
Параметры параметров.
Возвращаемое значение
Promise<RecipientTransferDetails>
decline(string, RecipientTransfersDeclineOptionalParams)
Отклоняет запрос на передачу.
function decline(transferName: string, options?: RecipientTransfersDeclineOptionalParams): Promise<RecipientTransferDetails>
Параметры
- transferName
-
string
Идентификатор, который однозначно идентифицирует запрос на передачу.
Параметры параметров.
Возвращаемое значение
Promise<RecipientTransferDetails>
get(string, RecipientTransfersGetOptionalParams)
Возвращает запрос на передачу по идентификатору. Вызывающий объект должен быть получателем запроса на передачу.
function get(transferName: string, options?: RecipientTransfersGetOptionalParams): Promise<RecipientTransferDetails>
Параметры
- transferName
-
string
Идентификатор, который однозначно идентифицирует запрос на передачу.
Параметры параметров.
Возвращаемое значение
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
Идентификатор, который однозначно идентифицирует запрос на передачу.
- parameters
- AcceptTransferRequest
Параметры запроса, предоставляемые для операции проверки передачи.
Параметры параметров.
Возвращаемое значение
Promise<ValidateTransferListResponse>