From 8ef95a62378a8fca563aa094ee897da06e05c438 Mon Sep 17 00:00:00 2001
From: David Baker <dave@matrix.org>
Date: Thu, 3 Jun 2021 14:38:13 +0100
Subject: [PATCH] Interface dispatcher payload

& use constant in test
---
 src/components/views/voip/DialPadModal.tsx   |  6 +++--
 src/dispatcher/actions.ts                    |  4 +---
 src/dispatcher/payloads/DialNumberPayload.ts | 23 ++++++++++++++++++++
 test/CallHandler-test.ts                     |  4 +++-
 4 files changed, 31 insertions(+), 6 deletions(-)
 create mode 100644 src/dispatcher/payloads/DialNumberPayload.ts

diff --git a/src/components/views/voip/DialPadModal.tsx b/src/components/views/voip/DialPadModal.tsx
index f3ee49e4ac..8c0af5e81a 100644
--- a/src/components/views/voip/DialPadModal.tsx
+++ b/src/components/views/voip/DialPadModal.tsx
@@ -21,6 +21,7 @@ import Field from "../elements/Field";
 import DialPad from './DialPad';
 import dis from '../../../dispatcher/dispatcher';
 import {replaceableComponent} from "../../../utils/replaceableComponent";
+import { DialNumberPayload } from "../../../dispatcher/payloads/DialNumberPayload";
 import { Action } from "../../../dispatcher/actions";
 
 interface IProps {
@@ -63,10 +64,11 @@ export default class DialpadModal extends React.PureComponent<IProps, IState> {
     }
 
     onDialPress = async () => {
-        dis.dispatch({
+        const payload: DialNumberPayload = {
             action: Action.DialNumber,
             number: this.state.value,
-        })
+        };
+        dis.dispatch(payload);
 
         this.props.onFinished(true);
     }
diff --git a/src/dispatcher/actions.ts b/src/dispatcher/actions.ts
index 073e82bef6..300eed2b98 100644
--- a/src/dispatcher/actions.ts
+++ b/src/dispatcher/actions.ts
@@ -102,9 +102,7 @@ export enum Action {
 
     /**
      * Dial the phone number in the payload
-     * payload: {
-     *     number: <phone number>,
-     * }
+     * payload: DialNumberPayload
      */
     DialNumber = "dial_number",
 
diff --git a/src/dispatcher/payloads/DialNumberPayload.ts b/src/dispatcher/payloads/DialNumberPayload.ts
new file mode 100644
index 0000000000..1b591b9f6b
--- /dev/null
+++ b/src/dispatcher/payloads/DialNumberPayload.ts
@@ -0,0 +1,23 @@
+/*
+Copyright 2021 The Matrix.org Foundation C.I.C.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+import { ActionPayload } from "../payloads";
+import { Action } from "../actions";
+
+export interface DialNumberPayload extends ActionPayload {
+    action: Action.DialNumber;
+    number: string;
+}
diff --git a/test/CallHandler-test.ts b/test/CallHandler-test.ts
index a93a134133..12316ac01c 100644
--- a/test/CallHandler-test.ts
+++ b/test/CallHandler-test.ts
@@ -25,6 +25,8 @@ import DMRoomMap from '../src/utils/DMRoomMap';
 import EventEmitter from 'events';
 import SdkConfig from '../src/SdkConfig';
 import { ActionPayload } from '../src/dispatcher/payloads';
+import { Actions } from '../src/notifications/types';
+import { Action } from '../src/dispatcher/actions';
 
 const REAL_ROOM_ID = '$room1:example.org';
 const MAPPED_ROOM_ID = '$room2:example.org';
@@ -172,7 +174,7 @@ describe('CallHandler', () => {
         }]);
 
         dis.dispatch({
-            action: 'dial_number',
+            action: Action.DialNumber,
             number: '01818118181',
         }, true);