stopAllBridges method

Future<DynamiteResponse<MatterbridgeSettingsStopAllBridgesResponseApplicationJson, void>> stopAllBridges({
  1. MatterbridgeSettingsStopAllBridgesApiVersion? apiVersion,
  2. bool? oCSAPIRequest,
})

Stop all bridges.

This endpoint requires admin access.

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 v1.
  • oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

  • 200: All bridges stopped successfully
  • 406: Stopping all bridges is not possible

See:

Implementation

Future<DynamiteResponse<MatterbridgeSettingsStopAllBridgesResponseApplicationJson, void>> stopAllBridges({
  MatterbridgeSettingsStopAllBridgesApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) async {
  final rawResponse = stopAllBridgesRaw(
    apiVersion: apiVersion,
    oCSAPIRequest: oCSAPIRequest,
  );

  return rawResponse.future;
}