@sendbird/calls-react-native
    Preparing search index...

    Interface SendbirdCallsNativeSpec

    interface SendbirdCallsNativeSpec {
        addListener: (eventType: string) => void;
        applicationId: string;
        createDirectCallLogListQuery: NativeQueryCreator<DirectCallLogQueryParams>;
        createRoomListQuery: NativeQueryCreator<RoomListQueryParams>;
        currentUser: User | null;
        removeListeners: (count: number) => void;
        accept(
            callId: string,
            options: CallOptions,
            holdActiveCall: boolean,
        ): Promise<void>;
        addDirectCallSound(type: SoundType, fileName: string): void;
        authenticate(authParams: AuthenticateParams): Promise<User>;
        createRoom(roomParams: RoomParams): Promise<RoomProperties>;
        deauthenticate(): Promise<void>;
        deleteAllCustomItems(callId: string): Promise<CustomItemUpdateResult>;
        deleteCustomItems(
            callId: string,
            customItemKeys: string[],
        ): Promise<CustomItemUpdateResult>;
        dial(
            calleeUserId: string,
            isVideoCall: boolean,
            options: CallOptions,
        ): Promise<DirectCallProperties>;
        directCallDeleteAllCustomItems(
            callId: string,
        ): Promise<CustomItemUpdateResult>;
        directCallDeleteCustomItems(
            callId: string,
            customItemKeys: string[],
        ): Promise<CustomItemUpdateResult>;
        directCallUpdateCustomItems(
            callId: string,
            customItems: Record<string, string>,
        ): Promise<CustomItemUpdateResult>;
        end(callId: string): Promise<void>;
        enter(roomId: string, options: EnterParams): Promise<void>;
        exit(roomId: string): void;
        fetchRoomById(roomId: string): Promise<RoomProperties>;
        getCachedRoomById(roomId: string): Promise<RoomProperties | null>;
        getConstants?(): {};
        getCurrentUser(): Promise<User | null>;
        getDirectCall(callId: string): Promise<DirectCallProperties>;
        getOngoingCalls(): Promise<DirectCallProperties[]>;
        groupCallDeleteAllCustomItems(
            roomId: string,
        ): Promise<CustomItemUpdateResult>;
        groupCallDeleteCustomItems(
            roomId: string,
            customItemKeys: string[],
        ): Promise<CustomItemUpdateResult>;
        groupCallUpdateCustomItems(
            roomId: string,
            customItems: Record<string, string>,
        ): Promise<CustomItemUpdateResult>;
        handleFirebaseMessageData(data: Record<string, string>): void;
        initialize(appId: string): boolean;
        muteMicrophone(type: ControllableModuleType, identifier: string): void;
        queryNext<T extends NativeQueryType>(
            key: `native#${string}`,
            type: T,
        ): NativeQueryResult<
            T extends DIRECT_CALL_LOG ? DirectCallLog : RoomProperties,
        >;
        queryRelease(key: `native#${string}`): void;
        registerPushToken(token: string, unique?: boolean): Promise<void>;
        registerVoIPPushToken(token: string, unique?: boolean): Promise<void>;
        removeDirectCallSound(type: SoundType): void;
        resumeAudioTrack(type: ControllableModuleType, identifier: string): void;
        resumeVideoCapturer(type: ControllableModuleType, identifier: string): void;
        routePickerView(): void;
        selectAudioDevice(
            type: ControllableModuleType,
            identifier: string,
            device: AudioDeviceType,
        ): Promise<void>;
        selectVideoDevice(
            type: ControllableModuleType,
            identifier: string,
            device: VideoDevice,
        ): Promise<void>;
        setDirectCallDialingSoundOnWhenSilentOrVibrateMode(enabled: boolean): void;
        setLoggerLevel(level: "none" | "error" | "warning" | "info"): void;
        startVideo(type: ControllableModuleType, identifier: string): void;
        stopVideo(type: ControllableModuleType, identifier: string): void;
        switchCamera(
            type: ControllableModuleType,
            identifier: string,
        ): Promise<void>;
        unmuteMicrophone(type: ControllableModuleType, identifier: string): void;
        unregisterPushToken(token: string): Promise<void>;
        unregisterVoIPPushToken(token: string): Promise<void>;
        updateCustomItems(
            callId: string,
            customItems: Record<string, string>,
        ): Promise<CustomItemUpdateResult>;
        updateLocalVideoView(callId: string, videoViewId: number): void;
        updateRemoteVideoView(callId: string, videoViewId: number): void;
    }

    Hierarchy (View Summary)

    Index

    Properties

    addListener applicationId createDirectCallLogListQuery createRoomListQuery currentUser removeListeners

    Methods

    accept addDirectCallSound authenticate createRoom deauthenticate deleteAllCustomItems deleteCustomItems dial directCallDeleteAllCustomItems directCallDeleteCustomItems directCallUpdateCustomItems end enter exit fetchRoomById getCachedRoomById getConstants? getCurrentUser getDirectCall getOngoingCalls groupCallDeleteAllCustomItems groupCallDeleteCustomItems groupCallUpdateCustomItems handleFirebaseMessageData initialize muteMicrophone queryNext queryRelease registerPushToken registerVoIPPushToken removeDirectCallSound resumeAudioTrack resumeVideoCapturer routePickerView selectAudioDevice selectVideoDevice setDirectCallDialingSoundOnWhenSilentOrVibrateMode setLoggerLevel startVideo stopVideo switchCamera unmuteMicrophone unregisterPushToken unregisterVoIPPushToken updateCustomItems updateLocalVideoView updateRemoteVideoView

    Properties

    addListener: (eventType: string) => void

    Add the provided eventType as an active listener

    Type Declaration

      • (eventType: string): void

      • Parameters

        • eventType: string

          name of the event for which we are registering listener

        Returns void

    applicationId: string
    createDirectCallLogListQuery: NativeQueryCreator<DirectCallLogQueryParams>
    createRoomListQuery: NativeQueryCreator<RoomListQueryParams>
    currentUser: User | null
    removeListeners: (count: number) => void

    Remove a specified number of events. There are no eventTypes in this case, as the native side doesn't remove the name, but only manages a counter of total listeners

    Type Declaration

      • (count: number): void

      • Parameters

        • count: number

          number of listeners to remove (of any type)

        Returns void

    Methods

    • Returns {}

    Settings

    Member Visibility

    On This Page

    Properties
    Methods