leaveFederatedCall method
Future<DynamiteResponse<CallLeaveFederatedCallResponseApplicationJson, void> >
leaveFederatedCall({
- required String token,
- required String sessionId,
- CallLeaveFederatedCallApiVersion? apiVersion,
- bool? oCSAPIRequest,
Leave a call on the host server using the session id of the federated user.
Returns a Future containing a DynamiteResponse
with the status code, deserialized body and headers.
Throws a DynamiteApiException
if the API call does not return an expected status code.
Parameters:
apiVersion
Defaults to"v4"
.token
sessionId
Federated session id to leave with.oCSAPIRequest
Required to be true for the API request to pass. Defaults totrue
.
Status codes:
- 200: Call left successfully
- 404: Call session not found
See:
- $leaveFederatedCall_Request for the request send by this method.
- $leaveFederatedCall_Serializer for a converter to parse the
Response
from an executed request.
Implementation
Future<_i1.DynamiteResponse<CallLeaveFederatedCallResponseApplicationJson, void>> leaveFederatedCall({
required String token,
required String sessionId,
CallLeaveFederatedCallApiVersion? apiVersion,
bool? oCSAPIRequest,
}) async {
final _request = $leaveFederatedCall_Request(
token: token,
sessionId: sessionId,
apiVersion: apiVersion,
oCSAPIRequest: oCSAPIRequest,
);
final _streamedResponse = await _rootClient.httpClient.send(_request);
final _response = await _i3.Response.fromStream(_streamedResponse);
final _serializer = $leaveFederatedCall_Serializer();
return _i1.ResponseConverter<CallLeaveFederatedCallResponseApplicationJson, void>(_serializer).convert(_response);
}