Skip to content

Fix: Corrected getAudioRoutes Typing and Code Cleanup #838

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fix: Corrected getAudioRoutes Typing and Code Cleanup #838

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
247 changes: 135 additions & 112 deletions index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,55 +16,73 @@ declare module 'react-native-callkeep' {
checkReachability: 'RNCallKeepCheckReachability';
didResetProvider: 'RNCallKeepProviderReset';
didLoadWithEvents: 'RNCallKeepDidLoadWithEvents';
onHasActiveCall : 'onHasActiveCall';
}
onHasActiveCall: 'onHasActiveCall';
};

export type InitialEvents = Array<{
[Event in Events]: { name: NativeEvents[Event], data: EventsPayload[Event] }
}[Events]>
export type InitialEvents = Array<
{
[Event in Events]: {
name: NativeEvents[Event];
data: EventsPayload[Event];
};
}[Events]
>;

export type Events = keyof NativeEvents;
export type EventsPayload = {
didReceiveStartCallAction: { handle: string, callUUID?: string, name?: string };
didReceiveStartCallAction: {
handle: string;
callUUID?: string;
name?: string;
};
answerCall: { callUUID: string };
endCall: { callUUID: string };
didActivateAudioSession: undefined;
didDeactivateAudioSession: undefined;
didDisplayIncomingCall: {
error?: string,
errorCode?: 'Unentitled' | 'CallUUIDAlreadyExists' | 'FilteredByDoNotDisturb' | 'FilteredByBlockList' | 'Unknown',
callUUID: string,
handle: string,
localizedCallerName: string,
hasVideo: '1' | '0',
fromPushKit: '1' | '0',
payload: object,
error?: string;
errorCode?:
| 'Unentitled'
| 'CallUUIDAlreadyExists'
| 'FilteredByDoNotDisturb'
| 'FilteredByBlockList'
| 'Unknown';
callUUID: string;
handle: string;
localizedCallerName: string;
hasVideo: '1' | '0';
fromPushKit: '1' | '0';
payload: object;
};
didPerformSetMutedCallAction: { muted: boolean, callUUID: string };
didToggleHoldCallAction: { hold: boolean, callUUID: string };
didPerformSetMutedCallAction: { muted: boolean; callUUID: string };
didToggleHoldCallAction: { hold: boolean; callUUID: string };
didChangeAudioRoute: {
output: string,
reason?: number,
handle?: string,
callUUID?: string,
output: string;
reason?: number;
handle?: string;
callUUID?: string;
};
didPerformDTMFAction: { digits: string; callUUID: string };
showIncomingCallUi: { handle: string; callUUID: string; name: string };
silenceIncomingCall: { handle: string; callUUID: string; name: string };
createIncomingConnectionFailed: {
handle: string;
callUUID: string;
name: string;
};
didPerformDTMFAction: { digits: string, callUUID: string };
showIncomingCallUi: { handle: string, callUUID: string, name: string };
silenceIncomingCall: { handle: string, callUUID: string, name: string };
createIncomingConnectionFailed: { handle: string, callUUID: string, name: string };
checkReachability: undefined;
didResetProvider: undefined;
didLoadWithEvents: InitialEvents;
onHasActiveCall : undefined;
}
onHasActiveCall: undefined;
};

type HandleType = 'generic' | 'number' | 'email';

export type AudioRoute = {
name: string,
type: string,
selected?: boolean
}
name: string;
type: string;
selected?: boolean;
};

export enum AudioSessionCategoryOption {
mixWithOthers = 0x1,
Expand All @@ -91,97 +109,97 @@ declare module 'react-native-callkeep' {

interface IOptions {
ios: {
appName: string,
imageName?: string,
supportsVideo?: boolean,
maximumCallGroups?: string,
maximumCallsPerCallGroup?: string,
ringtoneSound?: string,
includesCallsInRecents?: boolean
appName: string;
imageName?: string;
supportsVideo?: boolean;
maximumCallGroups?: string;
maximumCallsPerCallGroup?: string;
ringtoneSound?: string;
includesCallsInRecents?: boolean;
audioSession?: {
categoryOptions?: AudioSessionCategoryOption | number,
mode?: AudioSessionMode | string,
}
},
categoryOptions?: AudioSessionCategoryOption | number;
mode?: AudioSessionMode | string;
};
};
android: {
alertTitle: string,
alertDescription: string,
cancelButton: string,
okButton: string,
imageName?: string,
additionalPermissions: string[],
selfManaged?: boolean,
alertTitle: string;
alertDescription: string;
cancelButton: string;
okButton: string;
imageName?: string;
additionalPermissions: string[];
selfManaged?: boolean;
foregroundService?: {
channelId: string,
channelName: string,
notificationTitle: string,
notificationIcon?: string
}
}
channelId: string;
channelName: string;
notificationTitle: string;
notificationIcon?: string;
};
};
}

export const CONSTANTS: {
END_CALL_REASONS: {
FAILED: 1,
REMOTE_ENDED: 2,
UNANSWERED: 3,
ANSWERED_ELSEWHERE: 4,
DECLINED_ELSEWHERE: 5 | 2,
MISSED: 2 | 6
}
FAILED: 1;
REMOTE_ENDED: 2;
UNANSWERED: 3;
ANSWERED_ELSEWHERE: 4;
DECLINED_ELSEWHERE: 5 | 2;
MISSED: 2 | 6;
};
};

export class EventListener {
remove(): void
remove(): void;
}

export default class RNCallKeep {
static getInitialEvents(): Promise<InitialEvents>
static getInitialEvents(): Promise<InitialEvents>;

static clearInitialEvents(): void
static clearInitialEvents(): void;

static addEventListener<Event extends Events>(
type: Event,
handler: (args: EventsPayload[Event]) => void,
): EventListener
handler: (args: EventsPayload[Event]) => void
): EventListener;

static removeEventListener(type: Events): void
static removeEventListener(type: Events): void;

static setup(options: IOptions): Promise<boolean>
static setup(options: IOptions): Promise<boolean>;

static hasDefaultPhoneAccount(): boolean
static hasDefaultPhoneAccount(): boolean;

static answerIncomingCall(uuid: string): void
static answerIncomingCall(uuid: string): void;

static registerPhoneAccount(options: IOptions): void
static registerPhoneAccount(options: IOptions): void;

static registerAndroidEvents(): void
static registerAndroidEvents(): void;

static unregisterAndroidEvents(): void
static unregisterAndroidEvents(): void;

static displayIncomingCall(
uuid: string,
handle: string,
localizedCallerName?: string,
handleType?: HandleType,
hasVideo?: boolean,
options?: object,
): void
options?: object
): void;

static startCall(
uuid: string,
handle: string,
contactIdentifier?: string,
handleType?: HandleType,
hasVideo?: boolean,
): void
hasVideo?: boolean
): void;

static updateDisplay(
uuid: string,
displayName: string,
handle: string,
options?: object,
): void
options?: object
): void;

static checkPhoneAccountEnabled(): Promise<boolean>;

Expand All @@ -190,95 +208,100 @@ declare module 'react-native-callkeep' {
/**
* @description reportConnectedOutgoingCallWithUUID method is available only on iOS.
*/
static reportConnectedOutgoingCallWithUUID(uuid: string): void
static reportConnectedOutgoingCallWithUUID(uuid: string): void;

/**
* @description reportConnectedOutgoingCallWithUUID method is available only on iOS.
*/
static reportConnectingOutgoingCallWithUUID(uuid: string): void
static reportConnectingOutgoingCallWithUUID(uuid: string): void;

static reportEndCallWithUUID(uuid: string, reason: number): void
static reportEndCallWithUUID(uuid: string, reason: number): void;

static rejectCall(uuid: string): void
static rejectCall(uuid: string): void;

static endCall(uuid: string): void
static endCall(uuid: string): void;

static endAllCalls(): void
static endAllCalls(): void;

static setReachable(): void
static setReachable(): void;

static setSettings(settings: IOptions): void;

/**
* @description isCallActive method is available only on iOS.
*/
static isCallActive(uuid: string): Promise<boolean>
static isCallActive(uuid: string): Promise<boolean>;

static getCalls(): Promise<{
callUUID: string,
hasConnected: boolean,
hasEnded: boolean,
onHold: boolean,
outgoing: boolean
}[] | void>
static getCalls(): Promise<
| {
callUUID: string;
hasConnected: boolean;
hasEnded: boolean;
onHold: boolean;
outgoing: boolean;
}[]
| void
>;

static getAudioRoutes(): Promise<void>
static getAudioRoutes(): Promise<AudioRoute[]>;

static setAudioRoute: (uuid: string, inputName: string) => Promise<void>
static setAudioRoute: (uuid: string, inputName: string) => Promise<void>;

/**
* @description supportConnectionService method is available only on Android.
*/
static supportConnectionService(): boolean
static supportConnectionService(): boolean;

/**
* @description hasPhoneAccount method is available only on Android.
*/
static hasPhoneAccount(): Promise<boolean>
static hasPhoneAccount(): Promise<boolean>;

static hasOutgoingCall(): Promise<boolean>
static hasOutgoingCall(): Promise<boolean>;

/**
* @description setMutedCall method is available only on iOS.
*/
static setMutedCall(uuid: string, muted: boolean): void
static setMutedCall(uuid: string, muted: boolean): void;

/**
* @description toggleAudioRouteSpeaker method is available only on Android.
* @param uuid
* @param routeSpeaker
*/
static toggleAudioRouteSpeaker(uuid: string, routeSpeaker: boolean): void
static toggleAudioRouteSpeaker(uuid: string, routeSpeaker: boolean): void;

static setOnHold(uuid: string, held: boolean): void
static setOnHold(uuid: string, held: boolean): void;

static setConnectionState(uuid: string, state: number): void
static setConnectionState(uuid: string, state: number): void;

/**
* @descriptions sendDTMF is used to send DTMF tones to the PBX.
*/
static sendDTMF(uuid: string, key: string): void
static sendDTMF(uuid: string, key: string): void;

static checkIfBusy(): Promise<boolean>
static checkIfBusy(): Promise<boolean>;

static checkSpeaker(): Promise<boolean>
static checkSpeaker(): Promise<boolean>;

/**
* @description setAvailable method is available only on Android.
*/
static setAvailable(active: boolean): void
static setAvailable(active: boolean): void;

static setForegroundServiceSettings(settings: NonNullable<IOptions['android']['foregroundService']>): void
static setForegroundServiceSettings(
settings: NonNullable<IOptions['android']['foregroundService']>
): void;

static canMakeMultipleCalls(allow: boolean): void
static canMakeMultipleCalls(allow: boolean): void;

static setCurrentCallActive(callUUID: string): void
static setCurrentCallActive(callUUID: string): void;

static backToForeground(): void
static backToForeground(): void;

/**
* @descriptions Android Only, Check if there is active native call
*/
static checkIsInManagedCall(): Promise<boolean>
static checkIsInManagedCall(): Promise<boolean>;
}
}